Initial commit

This is definitely not functional yet.

Signed-off-by: Jacob Kiers <code@kiers.eu>

.gitignore

@@ -0,0 +1,4 @@
+/target/
+**/target/
+**/*.rs.bk
+.env

Cargo.toml

@@ -0,0 +1,11 @@
+[workspace]
+members = [
+    'bank2ff',
+    'firefly-iii-api',
+    'gocardless-bankaccount-data-api',
+]
+resolver = "2"
+
+[workspace.dependencies]
+tokio = {  version = "1", features = ['full'] }
+tokio-macros = "2.4.0"

README.md

@@ -0,0 +1,30 @@
+# Bank2FF
+
+Bank2FF is a tool that can retrieve bank transactions from Gocardless and
+add them to Firefly III.
+
+It contains autogenerated APIs for both Firefly III and for the
+Gocardless Bank Account Data API.
+
+## Usage
+
+TBD
+
+
+## Generating the API clients
+
+These API clients are generated with the OpenAPI Generators for Rust.
+
+These need Podman installed, and assume this command is run from the same
+directory where this README.md file is located.
+
+For Gocardless:
+
+`podman run --rm  -v ${PWD}:/local openapitools/openapi-generator-cli generate -g rust -o /local/gocardless-bankaccount-data-api -i 'https://bankaccountdata.gocardless.com/api/v2/swagger.json' --additional-properties=library=reqwest,packageName=gocardless-bankaccount-data-api,packageVersion=2.0.0,supportMiddleware=true,avoidBoxedModels=true`
+
+
+For Firefly III:
+
+If necessary, change the URL to the definition. If that is a new version, then also change the `packageVersion` parameter.
+
+`podman run --rm  -v ${PWD}:/local openapitools/openapi-generator-cli generate -g rust -o /local/firefly-iii-api -i 'https://api-docs.firefly-iii.org/firefly-iii-2.1.0-v1.yaml'  --additional-properties=library=reqwest,packageName=firefly-iii-api,packageVersion=2.1.0,supportMiddleware=true,avoidBoxedModels=true`

bank2ff/.env.example

@@ -0,0 +1,6 @@
+FIREFLY_III_URL=
+FIREFLY_III_API_KEY=
+FIREFLY_III_CLIENT_ID=
+
+GOCARDLESS_KEY=
+GOCARDLESS_ID=

bank2ff/.gitignore

@@ -0,0 +1,2 @@
+/target
+../.env

bank2ff/Cargo.toml

@@ -0,0 +1,11 @@
+[package]
+name = "bank2ff"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+firefly-iii-api = { path = "../firefly-iii-api", version = "2.1.0" }
+gocardless-bankaccount-data-api = { path = '../gocardless-bankaccount-data-api', version = "2.0.0" }
+dotenv = "0.15.0"
+serde = { version = "1.0.210", features = ["derive"] }
+tokio = { workspace = true, features = ["rt", "rt-multi-thread", "macros"] }

bank2ff/__asn_nordigen_import_config.json

@@ -0,0 +1,44 @@
+{
+    "version": 3,
+    "source": "ff3-importer-1.5.2",
+    "created_at": "2024-09-07T10:07:05+02:00",
+    "date": "",
+    "default_account": 1142,
+    "delimiter": "comma",
+    "headers": false,
+    "rules": true,
+    "skip_form": false,
+    "add_import_tag": true,
+    "roles": [],
+    "do_mapping": [],
+    "mapping": [],
+    "duplicate_detection_method": "classic",
+    "ignore_duplicate_lines": false,
+    "unique_column_index": 0,
+    "unique_column_type": "external-id",
+    "flow": "nordigen",
+    "content_type": "unknown",
+    "custom_tag": "",
+    "identifier": "0",
+    "connection": "0",
+    "ignore_spectre_categories": false,
+    "grouped_transaction_handling": "",
+    "use_entire_opposing_address": false,
+    "map_all_data": false,
+    "accounts": {
+        "4cda1369-178c-485b-b3d8-1892afdbfb6c": 1142
+    },
+    "date_range": "range",
+    "date_range_number": 30,
+    "date_range_unit": "d",
+    "date_not_before": "2024-06-29",
+    "date_not_after": "2024-09-06",
+    "nordigen_country": "NL",
+    "nordigen_bank": "ASN_BANK_ASNBNL21",
+    "nordigen_requisitions": {
+        "b2e6fd94-fc45-484c-abc1-5f410a58a220": "c5006758-135b-4770-8715-2a047a426973"
+    },
+    "nordigen_max_days": "90",
+    "conversion": false,
+    "ignore_duplicate_transactions": true
+}

bank2ff/src/config.rs

@@ -0,0 +1,29 @@
+use serde::Deserialize;
+
+#[derive(Deserialize, Debug)]
+pub(super) struct AppConfiguration {
+    pub(crate) firefly_iii_url: String,
+    pub(crate) firefly_iii_api_key: String,
+
+    pub(crate) go_cardless_key: String,
+    pub(crate) go_cardless_id: String,
+}
+
+impl AppConfiguration {
+    pub(super) fn from_env() -> Result<Self, dotenv::Error> {
+        use dotenv::var;
+
+        let firefly_iii_url = var("FIREFLY_III_URL")?;
+        let firefly_iii_api_key = var("FIREFLY_III_API_KEY")?;
+
+        let go_cardless_key = var("GOCARDLESS_KEY")?;
+        let go_cardless_id = var("GOCARDLESS_ID")?;
+
+        Ok(Self {
+            firefly_iii_url,
+            firefly_iii_api_key,
+            go_cardless_key,
+            go_cardless_id,
+        })
+    }
+}

bank2ff/src/firefly.rs

@@ -0,0 +1,108 @@
+use firefly_iii_api::apis::configuration::Configuration;
+use firefly_iii_api::apis::{accounts_api, transactions_api};
+use firefly_iii_api::models::{AccountRead, TransactionRead};
+
+pub(super) async fn load_all_transactions(ff: &mut FFTransactions) -> Result<(), ()> {
+    let mut has_more = true;
+    let mut page = None;
+    while has_more {
+        match transactions_api::list_transaction(
+            &ff.config,
+            None,
+            Some(500),
+            page,
+            None,
+            None,
+            None,
+        )
+        .await
+        {
+            Ok(transactions) => {
+                has_more = transactions.links.next.is_some();
+                let pagination = transactions.meta.pagination.clone().unwrap();
+                let next = pagination.current_page.unwrap() + 1;
+                page = Some(next);
+
+                println!(
+                    "Page {} of {}",
+                    pagination.current_page.unwrap(),
+                    pagination.total_pages.unwrap()
+                );
+                transactions
+            }
+            Err(e) => {
+                dbg!(e);
+                return Ok(());
+            }
+        }
+        .data
+        .iter()
+        .for_each(|tx| {
+            ff.transactions.push(tx.to_owned());
+        });
+    }
+
+    Ok(())
+}
+
+pub(super) async fn load_all_accounts(ff: &mut FFTransactions) -> Result<(), ()> {
+    let mut has_more = true;
+    let mut page = None;
+    while has_more {
+        match accounts_api::list_account(&ff.config, None, Some(500), page, None, None).await {
+            Ok(accounts) => {
+                let pagination = accounts.meta.pagination.clone().unwrap();
+                has_more = pagination.current_page < pagination.total_pages;
+
+                let next = pagination.current_page.unwrap() + 1;
+                page = Some(next);
+
+                println!(
+                    "Page {} of {}",
+                    pagination.current_page.unwrap(),
+                    pagination.total_pages.unwrap()
+                );
+
+                accounts.data
+            }
+            Err(e) => {
+                dbg!(e);
+                return Ok(());
+            }
+        }
+        .iter()
+        .for_each(|a| ff.accounts.push(a.to_owned()));
+    }
+
+    Ok(())
+}
+
+pub(super) struct FFTransactions {
+    accounts: Vec<AccountRead>,
+    transactions: Vec<TransactionRead>,
+    config: Configuration,
+}
+
+impl FFTransactions {
+    pub(super) fn new(config: Configuration) -> Self {
+        Self {
+            accounts: Vec::with_capacity(1000),
+            transactions: Vec::with_capacity(10000),
+            config,
+        }
+    }
+
+    pub(super) fn accounts(&self) -> &Vec<AccountRead> {
+        &self.accounts
+    }
+
+    pub(super) fn transactions(&self) -> &Vec<TransactionRead> {
+        &self.transactions
+    }
+
+    pub fn find_account_by_iban(&self, iban: &str) -> Option<&AccountRead> {
+        let to_check = Some(Some(iban.to_owned()));
+
+        self.accounts.iter().find(|a| a.attributes.iban == to_check)
+    }
+}

bank2ff/src/main.rs

@@ -0,0 +1,98 @@
+mod config;
+mod firefly;
+
+use crate::config::AppConfiguration;
+use crate::firefly::{load_all_accounts, load_all_transactions, FFTransactions};
+use firefly_iii_api::apis::configuration;
+use tokio::io::AsyncReadExt;
+use gocardless_bankaccount_data_api::models::{JwtObtainPairRequest, StatusEnum};
+
+#[tokio::main]
+async fn main() -> Result<(), dotenv::Error> {
+    dotenv::dotenv().ok();
+    let config = AppConfiguration::from_env()?;
+
+    // let mut ff = FFTransactions::new(configuration::Configuration {
+    //     base_path: config.firefly_iii_url,
+    //     user_agent: None,
+    //     client: Default::default(),
+    //     basic_auth: None,
+    //     oauth_access_token: None,
+    //     bearer_access_token: Some(config.firefly_iii_api_key),
+    //     api_key: None,
+    // });
+    //
+    // let _ = load_all_accounts(&mut ff).await;
+    // println!("#Accounts:\t{}", ff.accounts().len());
+
+    // let _ = load_all_transactions(&mut ff).await;
+    // println!("#Transactions:\t{}", ff.transactions().len());
+
+    let mut gocardless_config = gocardless_bankaccount_data_api::apis::configuration::Configuration::new();
+    let gc_token_pair = gocardless_bankaccount_data_api::apis::token_api::obtain_new_access_slash_refresh_token_pair(
+        &gocardless_config,JwtObtainPairRequest::new(config.go_cardless_id, config.go_cardless_key)).await.unwrap();
+
+    gocardless_config.bearer_access_token = gc_token_pair.access;
+
+
+    // let institutions = gocardless_bankaccount_data_api::apis::institutions_api::retrieve_all_supported_institutions_in_a_given_country(
+    //     &gocardless_config,
+    //     None,
+    //     None,
+    //     None,
+    //     None,
+    //     None,
+    //     Some("NL"),
+    //     None,
+    //     None,
+    //     None,
+    //     None,
+    //     None,
+    //     None,
+    //     None
+    // ).await.unwrap();
+
+    let gc_reqs = gocardless_bankaccount_data_api::apis::requisitions_api::retrieve_all_requisitions(&gocardless_config, None, None)
+        .await
+        .unwrap();
+
+    dbg!("# of requisitions:{} ", &gc_reqs.results.len());
+
+
+    let active_reqs = gc_reqs
+        .results.iter()
+        .filter(|req| req.status == Some(StatusEnum::Ln) && req.institution_id != "BUNQ_BUNQNL2A").collect::<Vec<_>>();
+
+
+    dbg!("# of active requisitions:{} ", &active_reqs.len());
+
+    for req in active_reqs {
+        if req.accounts.is_none() {
+            dbg!("No active accounts for requisition {}", req.id);
+            continue;
+        }
+
+        let accounts = req.accounts.as_ref().unwrap();
+
+        for account in accounts {
+            let transactions_resp = gocardless_bankaccount_data_api::apis::accounts_api::retrieve_account_transactions(
+                &gocardless_config,
+                &account.to_string(),
+                Some("2024-09-01".to_string()),
+                Some("2024-09-30".to_string())
+            ).await;
+
+            if transactions_resp.is_err() {
+                dbg!("{:?}", transactions_resp.unwrap_err());
+                // TODO: Do something smarter here, if possible
+                continue;
+            }
+
+            let transactions = transactions_resp.unwrap();
+            dbg!(&transactions);
+        }
+    }
+
+    let _ = tokio::io::stdin().read_u8().await;
+    Ok(())
+}

env.example

@@ -0,0 +1,6 @@
+FIREFLY_III_URL=
+FIREFLY_III_API_KEY=
+FIREFLY_III_CLIENT_ID=
+
+GOCARDLESS_KEY=
+GOCARDLESS_ID=

firefly-iii-api/.gitignore

@@ -0,0 +1,3 @@
+/target/
+**/*.rs.bk
+Cargo.lock

firefly-iii-api/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

firefly-iii-api/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,5 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+  </profile>
+</component>

firefly-iii-api/.idea/misc.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectInspectionProfilesVisibleTreeState">
+    <entry key="Project Default">
+      <profile-state>
+        <expanded-state>
+          <State />
+          <State>
+            <id>SQL</id>
+          </State>
+        </expanded-state>
+        <selected-state>
+          <State>
+            <id>CSS</id>
+          </State>
+        </selected-state>
+      </profile-state>
+    </entry>
+  </component>
+</project>

firefly-iii-api/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/rust.iml" filepath="$PROJECT_DIR$/.idea/rust.iml" />
+    </modules>
+  </component>
+</project>

firefly-iii-api/.idea/rust.iml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="EMPTY_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" />
+      <excludeFolder url="file://$MODULE_DIR$/target" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

firefly-iii-api/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

firefly-iii-api/.openapi-generator/FILES

@@ -0,0 +1,484 @@
+.gitignore
+.openapi-generator-ignore
+.travis.yml
+Cargo.toml
+README.md
+docs/AboutApi.md
+docs/Account.md
+docs/AccountArray.md
+docs/AccountRead.md
+docs/AccountRoleProperty.md
+docs/AccountSearchFieldFilter.md
+docs/AccountSingle.md
+docs/AccountStore.md
+docs/AccountTypeFilter.md
+docs/AccountTypeProperty.md
+docs/AccountUpdate.md
+docs/AccountsApi.md
+docs/AttachableType.md
+docs/Attachment.md
+docs/AttachmentArray.md
+docs/AttachmentRead.md
+docs/AttachmentSingle.md
+docs/AttachmentStore.md
+docs/AttachmentUpdate.md
+docs/AttachmentsApi.md
+docs/AutoBudgetPeriod.md
+docs/AutoBudgetType.md
+docs/AutocompleteAccount.md
+docs/AutocompleteApi.md
+docs/AutocompleteBill.md
+docs/AutocompleteBudget.md
+docs/AutocompleteCategory.md
+docs/AutocompleteCurrency.md
+docs/AutocompleteCurrencyCode.md
+docs/AutocompleteObjectGroup.md
+docs/AutocompletePiggy.md
+docs/AutocompletePiggyBalance.md
+docs/AutocompleteRecurrence.md
+docs/AutocompleteRule.md
+docs/AutocompleteRuleGroup.md
+docs/AutocompleteTag.md
+docs/AutocompleteTransaction.md
+docs/AutocompleteTransactionId.md
+docs/AutocompleteTransactionType.md
+docs/AvailableBudget.md
+docs/AvailableBudgetArray.md
+docs/AvailableBudgetRead.md
+docs/AvailableBudgetSingle.md
+docs/AvailableBudgetsApi.md
+docs/BadRequestResponse.md
+docs/BasicSummaryEntry.md
+docs/Bill.md
+docs/BillArray.md
+docs/BillPaidDatesInner.md
+docs/BillRead.md
+docs/BillRepeatFrequency.md
+docs/BillSingle.md
+docs/BillStore.md
+docs/BillUpdate.md
+docs/BillsApi.md
+docs/Budget.md
+docs/BudgetArray.md
+docs/BudgetLimit.md
+docs/BudgetLimitArray.md
+docs/BudgetLimitRead.md
+docs/BudgetLimitSingle.md
+docs/BudgetLimitStore.md
+docs/BudgetRead.md
+docs/BudgetSingle.md
+docs/BudgetSpent.md
+docs/BudgetStore.md
+docs/BudgetUpdate.md
+docs/BudgetsApi.md
+docs/CategoriesApi.md
+docs/Category.md
+docs/CategoryArray.md
+docs/CategoryEarned.md
+docs/CategoryRead.md
+docs/CategorySingle.md
+docs/CategorySpent.md
+docs/CategoryUpdate.md
+docs/ChartDataPoint.md
+docs/ChartDataSet.md
+docs/ChartsApi.md
+docs/ConfigValueFilter.md
+docs/ConfigValueUpdateFilter.md
+docs/Configuration.md
+docs/ConfigurationApi.md
+docs/ConfigurationSingle.md
+docs/ConfigurationUpdate.md
+docs/CreditCardTypeProperty.md
+docs/CronResult.md
+docs/CronResultRow.md
+docs/CurrenciesApi.md
+docs/Currency.md
+docs/CurrencyArray.md
+docs/CurrencyRead.md
+docs/CurrencySingle.md
+docs/CurrencyStore.md
+docs/CurrencyUpdate.md
+docs/DataApi.md
+docs/DataDestroyObject.md
+docs/ExportFileFilter.md
+docs/InsightApi.md
+docs/InsightGroupEntry.md
+docs/InsightTotalEntry.md
+docs/InsightTransferEntry.md
+docs/InterestPeriodProperty.md
+docs/InternalExceptionResponse.md
+docs/LiabilityDirectionProperty.md
+docs/LiabilityTypeProperty.md
+docs/LinkType.md
+docs/LinkTypeArray.md
+docs/LinkTypeRead.md
+docs/LinkTypeSingle.md
+docs/LinkTypeUpdate.md
+docs/LinksApi.md
+docs/Meta.md
+docs/MetaPagination.md
+docs/NotFoundResponse.md
+docs/ObjectGroup.md
+docs/ObjectGroupArray.md
+docs/ObjectGroupRead.md
+docs/ObjectGroupSingle.md
+docs/ObjectGroupUpdate.md
+docs/ObjectGroupsApi.md
+docs/ObjectLink.md
+docs/ObjectLink0.md
+docs/PageLink.md
+docs/PiggyBank.md
+docs/PiggyBankArray.md
+docs/PiggyBankEvent.md
+docs/PiggyBankEventArray.md
+docs/PiggyBankEventRead.md
+docs/PiggyBankRead.md
+docs/PiggyBankSingle.md
+docs/PiggyBankStore.md
+docs/PiggyBankUpdate.md
+docs/PiggyBanksApi.md
+docs/PolymorphicProperty.md
+docs/Preference.md
+docs/PreferenceArray.md
+docs/PreferenceRead.md
+docs/PreferenceSingle.md
+docs/PreferenceUpdate.md
+docs/PreferencesApi.md
+docs/Recurrence.md
+docs/RecurrenceArray.md
+docs/RecurrenceRead.md
+docs/RecurrenceRepetition.md
+docs/RecurrenceRepetitionStore.md
+docs/RecurrenceRepetitionType.md
+docs/RecurrenceRepetitionUpdate.md
+docs/RecurrenceSingle.md
+docs/RecurrenceStore.md
+docs/RecurrenceTransaction.md
+docs/RecurrenceTransactionStore.md
+docs/RecurrenceTransactionType.md
+docs/RecurrenceTransactionUpdate.md
+docs/RecurrenceUpdate.md
+docs/RecurrencesApi.md
+docs/Rule.md
+docs/RuleAction.md
+docs/RuleActionKeyword.md
+docs/RuleActionStore.md
+docs/RuleActionUpdate.md
+docs/RuleArray.md
+docs/RuleGroup.md
+docs/RuleGroupArray.md
+docs/RuleGroupRead.md
+docs/RuleGroupSingle.md
+docs/RuleGroupStore.md
+docs/RuleGroupUpdate.md
+docs/RuleGroupsApi.md
+docs/RuleRead.md
+docs/RuleSingle.md
+docs/RuleStore.md
+docs/RuleTrigger.md
+docs/RuleTriggerKeyword.md
+docs/RuleTriggerStore.md
+docs/RuleTriggerType.md
+docs/RuleTriggerUpdate.md
+docs/RuleUpdate.md
+docs/RulesApi.md
+docs/SearchApi.md
+docs/ShortAccountTypeProperty.md
+docs/SummaryApi.md
+docs/SystemInfo.md
+docs/SystemInfoData.md
+docs/TagArray.md
+docs/TagModel.md
+docs/TagModelStore.md
+docs/TagModelUpdate.md
+docs/TagRead.md
+docs/TagSingle.md
+docs/TagsApi.md
+docs/Transaction.md
+docs/TransactionArray.md
+docs/TransactionLink.md
+docs/TransactionLinkArray.md
+docs/TransactionLinkRead.md
+docs/TransactionLinkSingle.md
+docs/TransactionLinkStore.md
+docs/TransactionLinkUpdate.md
+docs/TransactionRead.md
+docs/TransactionSingle.md
+docs/TransactionSplit.md
+docs/TransactionSplitStore.md
+docs/TransactionSplitUpdate.md
+docs/TransactionStore.md
+docs/TransactionTypeFilter.md
+docs/TransactionTypeProperty.md
+docs/TransactionUpdate.md
+docs/TransactionsApi.md
+docs/UnauthenticatedResponse.md
+docs/User.md
+docs/UserArray.md
+docs/UserBlockedCodeProperty.md
+docs/UserRead.md
+docs/UserRoleProperty.md
+docs/UserSingle.md
+docs/UsersApi.md
+docs/ValidationErrorResponse.md
+docs/ValidationErrorResponseErrors.md
+docs/Webhook.md
+docs/WebhookArray.md
+docs/WebhookAttempt.md
+docs/WebhookAttemptArray.md
+docs/WebhookAttemptRead.md
+docs/WebhookAttemptSingle.md
+docs/WebhookDelivery.md
+docs/WebhookMessage.md
+docs/WebhookMessageArray.md
+docs/WebhookMessageRead.md
+docs/WebhookMessageSingle.md
+docs/WebhookRead.md
+docs/WebhookResponse.md
+docs/WebhookSingle.md
+docs/WebhookStore.md
+docs/WebhookTrigger.md
+docs/WebhookUpdate.md
+docs/WebhooksApi.md
+git_push.sh
+src/apis/about_api.rs
+src/apis/accounts_api.rs
+src/apis/attachments_api.rs
+src/apis/autocomplete_api.rs
+src/apis/available_budgets_api.rs
+src/apis/bills_api.rs
+src/apis/budgets_api.rs
+src/apis/categories_api.rs
+src/apis/charts_api.rs
+src/apis/configuration.rs
+src/apis/configuration_api.rs
+src/apis/currencies_api.rs
+src/apis/data_api.rs
+src/apis/insight_api.rs
+src/apis/links_api.rs
+src/apis/mod.rs
+src/apis/object_groups_api.rs
+src/apis/piggy_banks_api.rs
+src/apis/preferences_api.rs
+src/apis/recurrences_api.rs
+src/apis/rule_groups_api.rs
+src/apis/rules_api.rs
+src/apis/search_api.rs
+src/apis/summary_api.rs
+src/apis/tags_api.rs
+src/apis/transactions_api.rs
+src/apis/users_api.rs
+src/apis/webhooks_api.rs
+src/lib.rs
+src/models/account.rs
+src/models/account_array.rs
+src/models/account_read.rs
+src/models/account_role_property.rs
+src/models/account_search_field_filter.rs
+src/models/account_single.rs
+src/models/account_store.rs
+src/models/account_type_filter.rs
+src/models/account_type_property.rs
+src/models/account_update.rs
+src/models/attachable_type.rs
+src/models/attachment.rs
+src/models/attachment_array.rs
+src/models/attachment_read.rs
+src/models/attachment_single.rs
+src/models/attachment_store.rs
+src/models/attachment_update.rs
+src/models/auto_budget_period.rs
+src/models/auto_budget_type.rs
+src/models/autocomplete_account.rs
+src/models/autocomplete_bill.rs
+src/models/autocomplete_budget.rs
+src/models/autocomplete_category.rs
+src/models/autocomplete_currency.rs
+src/models/autocomplete_currency_code.rs
+src/models/autocomplete_object_group.rs
+src/models/autocomplete_piggy.rs
+src/models/autocomplete_piggy_balance.rs
+src/models/autocomplete_recurrence.rs
+src/models/autocomplete_rule.rs
+src/models/autocomplete_rule_group.rs
+src/models/autocomplete_tag.rs
+src/models/autocomplete_transaction.rs
+src/models/autocomplete_transaction_id.rs
+src/models/autocomplete_transaction_type.rs
+src/models/available_budget.rs
+src/models/available_budget_array.rs
+src/models/available_budget_read.rs
+src/models/available_budget_single.rs
+src/models/bad_request_response.rs
+src/models/basic_summary_entry.rs
+src/models/bill.rs
+src/models/bill_array.rs
+src/models/bill_paid_dates_inner.rs
+src/models/bill_read.rs
+src/models/bill_repeat_frequency.rs
+src/models/bill_single.rs
+src/models/bill_store.rs
+src/models/bill_update.rs
+src/models/budget.rs
+src/models/budget_array.rs
+src/models/budget_limit.rs
+src/models/budget_limit_array.rs
+src/models/budget_limit_read.rs
+src/models/budget_limit_single.rs
+src/models/budget_limit_store.rs
+src/models/budget_read.rs
+src/models/budget_single.rs
+src/models/budget_spent.rs
+src/models/budget_store.rs
+src/models/budget_update.rs
+src/models/category.rs
+src/models/category_array.rs
+src/models/category_earned.rs
+src/models/category_read.rs
+src/models/category_single.rs
+src/models/category_spent.rs
+src/models/category_update.rs
+src/models/chart_data_point.rs
+src/models/chart_data_set.rs
+src/models/config_value_filter.rs
+src/models/config_value_update_filter.rs
+src/models/configuration.rs
+src/models/configuration_single.rs
+src/models/configuration_update.rs
+src/models/credit_card_type_property.rs
+src/models/cron_result.rs
+src/models/cron_result_row.rs
+src/models/currency.rs
+src/models/currency_array.rs
+src/models/currency_read.rs
+src/models/currency_single.rs
+src/models/currency_store.rs
+src/models/currency_update.rs
+src/models/data_destroy_object.rs
+src/models/export_file_filter.rs
+src/models/insight_group_entry.rs
+src/models/insight_total_entry.rs
+src/models/insight_transfer_entry.rs
+src/models/interest_period_property.rs
+src/models/internal_exception_response.rs
+src/models/liability_direction_property.rs
+src/models/liability_type_property.rs
+src/models/link_type.rs
+src/models/link_type_array.rs
+src/models/link_type_read.rs
+src/models/link_type_single.rs
+src/models/link_type_update.rs
+src/models/meta.rs
+src/models/meta_pagination.rs
+src/models/mod.rs
+src/models/not_found_response.rs
+src/models/object_group.rs
+src/models/object_group_array.rs
+src/models/object_group_read.rs
+src/models/object_group_single.rs
+src/models/object_group_update.rs
+src/models/object_link.rs
+src/models/object_link_0.rs
+src/models/page_link.rs
+src/models/piggy_bank.rs
+src/models/piggy_bank_array.rs
+src/models/piggy_bank_event.rs
+src/models/piggy_bank_event_array.rs
+src/models/piggy_bank_event_read.rs
+src/models/piggy_bank_read.rs
+src/models/piggy_bank_single.rs
+src/models/piggy_bank_store.rs
+src/models/piggy_bank_update.rs
+src/models/polymorphic_property.rs
+src/models/preference.rs
+src/models/preference_array.rs
+src/models/preference_read.rs
+src/models/preference_single.rs
+src/models/preference_update.rs
+src/models/recurrence.rs
+src/models/recurrence_array.rs
+src/models/recurrence_read.rs
+src/models/recurrence_repetition.rs
+src/models/recurrence_repetition_store.rs
+src/models/recurrence_repetition_type.rs
+src/models/recurrence_repetition_update.rs
+src/models/recurrence_single.rs
+src/models/recurrence_store.rs
+src/models/recurrence_transaction.rs
+src/models/recurrence_transaction_store.rs
+src/models/recurrence_transaction_type.rs
+src/models/recurrence_transaction_update.rs
+src/models/recurrence_update.rs
+src/models/rule.rs
+src/models/rule_action.rs
+src/models/rule_action_keyword.rs
+src/models/rule_action_store.rs
+src/models/rule_action_update.rs
+src/models/rule_array.rs
+src/models/rule_group.rs
+src/models/rule_group_array.rs
+src/models/rule_group_read.rs
+src/models/rule_group_single.rs
+src/models/rule_group_store.rs
+src/models/rule_group_update.rs
+src/models/rule_read.rs
+src/models/rule_single.rs
+src/models/rule_store.rs
+src/models/rule_trigger.rs
+src/models/rule_trigger_keyword.rs
+src/models/rule_trigger_store.rs
+src/models/rule_trigger_type.rs
+src/models/rule_trigger_update.rs
+src/models/rule_update.rs
+src/models/short_account_type_property.rs
+src/models/system_info.rs
+src/models/system_info_data.rs
+src/models/tag_array.rs
+src/models/tag_model.rs
+src/models/tag_model_store.rs
+src/models/tag_model_update.rs
+src/models/tag_read.rs
+src/models/tag_single.rs
+src/models/transaction.rs
+src/models/transaction_array.rs
+src/models/transaction_link.rs
+src/models/transaction_link_array.rs
+src/models/transaction_link_read.rs
+src/models/transaction_link_single.rs
+src/models/transaction_link_store.rs
+src/models/transaction_link_update.rs
+src/models/transaction_read.rs
+src/models/transaction_single.rs
+src/models/transaction_split.rs
+src/models/transaction_split_store.rs
+src/models/transaction_split_update.rs
+src/models/transaction_store.rs
+src/models/transaction_type_filter.rs
+src/models/transaction_type_property.rs
+src/models/transaction_update.rs
+src/models/unauthenticated_response.rs
+src/models/user.rs
+src/models/user_array.rs
+src/models/user_blocked_code_property.rs
+src/models/user_read.rs
+src/models/user_role_property.rs
+src/models/user_single.rs
+src/models/validation_error_response.rs
+src/models/validation_error_response_errors.rs
+src/models/webhook.rs
+src/models/webhook_array.rs
+src/models/webhook_attempt.rs
+src/models/webhook_attempt_array.rs
+src/models/webhook_attempt_read.rs
+src/models/webhook_attempt_single.rs
+src/models/webhook_delivery.rs
+src/models/webhook_message.rs
+src/models/webhook_message_array.rs
+src/models/webhook_message_read.rs
+src/models/webhook_message_single.rs
+src/models/webhook_read.rs
+src/models/webhook_response.rs
+src/models/webhook_single.rs
+src/models/webhook_store.rs
+src/models/webhook_trigger.rs
+src/models/webhook_update.rs

firefly-iii-api/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.9.0-SNAPSHOT

firefly-iii-api/.travis.yml

@@ -0,0 +1 @@
+language: rust

firefly-iii-api/Cargo.toml

@@ -0,0 +1,16 @@
+[package]
+name = "firefly-iii-api"
+version = "2.1.0"
+authors = ["james@firefly-iii.org"]
+description = "This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-09-10T05:07:57+00:00  Please 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 Postman to make requests. Too many script kiddies out there, sorry about that. "
+license = "AGPLv3"
+edition = "2021"
+
+[dependencies]
+serde = { version = "^1.0", features = ["derive"] }
+serde_with = { version = "^3.8", default-features = false, features = ["base64", "std", "macros"] }
+serde_json = "^1.0"
+serde_repr = "^0.1"
+url = "^2.5"
+uuid = { version = "^1.8", features = ["serde", "v4"] }
+reqwest = { version = "^0.12", features = ["json", "multipart"] }

firefly-iii-api/README.md

@@ -0,0 +1,467 @@
+# Rust API client for openapi
+
+This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-09-10T05:07:57+00:00
+
+Please 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 Postman to make requests. Too many script kiddies out there, sorry about that.
+
+
+For more information, please visit [https://firefly-iii.org](https://firefly-iii.org)
+
+## Overview
+
+This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.
+
+- API version: 2.1.0
+- Package version: 2.1.0
+- Generator version: 7.9.0-SNAPSHOT
+- Build package: `org.openapitools.codegen.languages.RustClientCodegen`
+
+## Installation
+
+Put the package under your project folder in a directory named `openapi` and add the following to `Cargo.toml` under `[dependencies]`:
+
+```
+openapi = { path = "./openapi" }
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://demo.firefly-iii.org/api*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*AboutApi* | [**get_about**](docs/AboutApi.md#get_about) | **GET** /v1/about | System information end point.
+*AboutApi* | [**get_cron**](docs/AboutApi.md#get_cron) | **GET** /v1/cron/{cliToken} | Cron job endpoint
+*AboutApi* | [**get_current_user**](docs/AboutApi.md#get_current_user) | **GET** /v1/about/user | Currently authenticated user endpoint.
+*AccountsApi* | [**delete_account**](docs/AccountsApi.md#delete_account) | **DELETE** /v1/accounts/{id} | Permanently delete account.
+*AccountsApi* | [**get_account**](docs/AccountsApi.md#get_account) | **GET** /v1/accounts/{id} | Get single account.
+*AccountsApi* | [**list_account**](docs/AccountsApi.md#list_account) | **GET** /v1/accounts | List all accounts.
+*AccountsApi* | [**list_attachment_by_account**](docs/AccountsApi.md#list_attachment_by_account) | **GET** /v1/accounts/{id}/attachments | Lists all attachments.
+*AccountsApi* | [**list_piggy_bank_by_account**](docs/AccountsApi.md#list_piggy_bank_by_account) | **GET** /v1/accounts/{id}/piggy-banks | List all piggy banks related to the account.
+*AccountsApi* | [**list_transaction_by_account**](docs/AccountsApi.md#list_transaction_by_account) | **GET** /v1/accounts/{id}/transactions | List all transactions related to the account.
+*AccountsApi* | [**store_account**](docs/AccountsApi.md#store_account) | **POST** /v1/accounts | Create new account.
+*AccountsApi* | [**update_account**](docs/AccountsApi.md#update_account) | **PUT** /v1/accounts/{id} | Update existing account.
+*AttachmentsApi* | [**delete_attachment**](docs/AttachmentsApi.md#delete_attachment) | **DELETE** /v1/attachments/{id} | Delete an attachment.
+*AttachmentsApi* | [**download_attachment**](docs/AttachmentsApi.md#download_attachment) | **GET** /v1/attachments/{id}/download | Download a single attachment.
+*AttachmentsApi* | [**get_attachment**](docs/AttachmentsApi.md#get_attachment) | **GET** /v1/attachments/{id} | Get a single attachment.
+*AttachmentsApi* | [**list_attachment**](docs/AttachmentsApi.md#list_attachment) | **GET** /v1/attachments | List all attachments.
+*AttachmentsApi* | [**store_attachment**](docs/AttachmentsApi.md#store_attachment) | **POST** /v1/attachments | Store a new attachment.
+*AttachmentsApi* | [**update_attachment**](docs/AttachmentsApi.md#update_attachment) | **PUT** /v1/attachments/{id} | Update existing attachment.
+*AttachmentsApi* | [**upload_attachment**](docs/AttachmentsApi.md#upload_attachment) | **POST** /v1/attachments/{id}/upload | Upload an attachment.
+*AutocompleteApi* | [**get_accounts_ac**](docs/AutocompleteApi.md#get_accounts_ac) | **GET** /v1/autocomplete/accounts | Returns all accounts of the user returned in a basic auto-complete array.
+*AutocompleteApi* | [**get_bills_ac**](docs/AutocompleteApi.md#get_bills_ac) | **GET** /v1/autocomplete/bills | Returns all bills of the user returned in a basic auto-complete array.
+*AutocompleteApi* | [**get_budgets_ac**](docs/AutocompleteApi.md#get_budgets_ac) | **GET** /v1/autocomplete/budgets | Returns all budgets of the user returned in a basic auto-complete array.
+*AutocompleteApi* | [**get_categories_ac**](docs/AutocompleteApi.md#get_categories_ac) | **GET** /v1/autocomplete/categories | Returns all categories of the user returned in a basic auto-complete array.
+*AutocompleteApi* | [**get_currencies_ac**](docs/AutocompleteApi.md#get_currencies_ac) | **GET** /v1/autocomplete/currencies | Returns all currencies of the user returned in a basic auto-complete array.
+*AutocompleteApi* | [**get_currencies_code_ac**](docs/AutocompleteApi.md#get_currencies_code_ac) | **GET** /v1/autocomplete/currencies-with-code | Returns all currencies of the user returned in a basic auto-complete array. This endpoint is DEPRECATED and I suggest you DO NOT use it.
+*AutocompleteApi* | [**get_object_groups_ac**](docs/AutocompleteApi.md#get_object_groups_ac) | **GET** /v1/autocomplete/object-groups | Returns all object groups of the user returned in a basic auto-complete array.
+*AutocompleteApi* | [**get_piggies_ac**](docs/AutocompleteApi.md#get_piggies_ac) | **GET** /v1/autocomplete/piggy-banks | Returns all piggy banks of the user returned in a basic auto-complete array.
+*AutocompleteApi* | [**get_piggies_balance_ac**](docs/AutocompleteApi.md#get_piggies_balance_ac) | **GET** /v1/autocomplete/piggy-banks-with-balance | Returns all piggy banks of the user returned in a basic auto-complete array complemented with balance information.
+*AutocompleteApi* | [**get_recurring_ac**](docs/AutocompleteApi.md#get_recurring_ac) | **GET** /v1/autocomplete/recurring | Returns all recurring transactions of the user returned in a basic auto-complete array.
+*AutocompleteApi* | [**get_rule_groups_ac**](docs/AutocompleteApi.md#get_rule_groups_ac) | **GET** /v1/autocomplete/rule-groups | Returns all rule groups of the user returned in a basic auto-complete array.
+*AutocompleteApi* | [**get_rules_ac**](docs/AutocompleteApi.md#get_rules_ac) | **GET** /v1/autocomplete/rules | Returns all rules of the user returned in a basic auto-complete array.
+*AutocompleteApi* | [**get_tag_ac**](docs/AutocompleteApi.md#get_tag_ac) | **GET** /v1/autocomplete/tags | Returns all tags of the user returned in a basic auto-complete array.
+*AutocompleteApi* | [**get_transaction_types_ac**](docs/AutocompleteApi.md#get_transaction_types_ac) | **GET** /v1/autocomplete/transaction-types | Returns all transaction types returned in a basic auto-complete array. English only.
+*AutocompleteApi* | [**get_transactions_ac**](docs/AutocompleteApi.md#get_transactions_ac) | **GET** /v1/autocomplete/transactions | Returns all transaction descriptions of the user returned in a basic auto-complete array.
+*AutocompleteApi* | [**get_transactions_idac**](docs/AutocompleteApi.md#get_transactions_idac) | **GET** /v1/autocomplete/transactions-with-id | Returns all transactions, complemented with their ID, of the user returned in a basic auto-complete array. This endpoint is DEPRECATED and I suggest you DO NOT use it.
+*AvailableBudgetsApi* | [**get_available_budget**](docs/AvailableBudgetsApi.md#get_available_budget) | **GET** /v1/available-budgets/{id} | Get a single available budget.
+*AvailableBudgetsApi* | [**list_available_budget**](docs/AvailableBudgetsApi.md#list_available_budget) | **GET** /v1/available-budgets | List all available budget amounts.
+*BillsApi* | [**delete_bill**](docs/BillsApi.md#delete_bill) | **DELETE** /v1/bills/{id} | Delete a bill.
+*BillsApi* | [**get_bill**](docs/BillsApi.md#get_bill) | **GET** /v1/bills/{id} | Get a single bill.
+*BillsApi* | [**list_attachment_by_bill**](docs/BillsApi.md#list_attachment_by_bill) | **GET** /v1/bills/{id}/attachments | List all attachments uploaded to the bill.
+*BillsApi* | [**list_bill**](docs/BillsApi.md#list_bill) | **GET** /v1/bills | List all bills.
+*BillsApi* | [**list_rule_by_bill**](docs/BillsApi.md#list_rule_by_bill) | **GET** /v1/bills/{id}/rules | List all rules associated with the bill.
+*BillsApi* | [**list_transaction_by_bill**](docs/BillsApi.md#list_transaction_by_bill) | **GET** /v1/bills/{id}/transactions | List all transactions associated with the  bill.
+*BillsApi* | [**store_bill**](docs/BillsApi.md#store_bill) | **POST** /v1/bills | Store a new bill
+*BillsApi* | [**update_bill**](docs/BillsApi.md#update_bill) | **PUT** /v1/bills/{id} | Update existing bill.
+*BudgetsApi* | [**delete_budget**](docs/BudgetsApi.md#delete_budget) | **DELETE** /v1/budgets/{id} | Delete a budget.
+*BudgetsApi* | [**delete_budget_limit**](docs/BudgetsApi.md#delete_budget_limit) | **DELETE** /v1/budgets/{id}/limits/{limitId} | Delete a budget limit.
+*BudgetsApi* | [**get_budget**](docs/BudgetsApi.md#get_budget) | **GET** /v1/budgets/{id} | Get a single budget.
+*BudgetsApi* | [**get_budget_limit**](docs/BudgetsApi.md#get_budget_limit) | **GET** /v1/budgets/{id}/limits/{limitId} | Get single budget limit.
+*BudgetsApi* | [**list_attachment_by_budget**](docs/BudgetsApi.md#list_attachment_by_budget) | **GET** /v1/budgets/{id}/attachments | Lists all attachments of a budget.
+*BudgetsApi* | [**list_budget**](docs/BudgetsApi.md#list_budget) | **GET** /v1/budgets | List all budgets.
+*BudgetsApi* | [**list_budget_limit**](docs/BudgetsApi.md#list_budget_limit) | **GET** /v1/budget-limits | Get list of budget limits by date
+*BudgetsApi* | [**list_budget_limit_by_budget**](docs/BudgetsApi.md#list_budget_limit_by_budget) | **GET** /v1/budgets/{id}/limits | Get all limits for a budget.
+*BudgetsApi* | [**list_transaction_by_budget**](docs/BudgetsApi.md#list_transaction_by_budget) | **GET** /v1/budgets/{id}/transactions | All transactions to a budget.
+*BudgetsApi* | [**list_transaction_by_budget_limit**](docs/BudgetsApi.md#list_transaction_by_budget_limit) | **GET** /v1/budgets/{id}/limits/{limitId}/transactions | List all transactions by a budget limit ID.
+*BudgetsApi* | [**store_budget**](docs/BudgetsApi.md#store_budget) | **POST** /v1/budgets | Store a new budget
+*BudgetsApi* | [**store_budget_limit**](docs/BudgetsApi.md#store_budget_limit) | **POST** /v1/budgets/{id}/limits | Store new budget limit.
+*BudgetsApi* | [**update_budget**](docs/BudgetsApi.md#update_budget) | **PUT** /v1/budgets/{id} | Update existing budget.
+*BudgetsApi* | [**update_budget_limit**](docs/BudgetsApi.md#update_budget_limit) | **PUT** /v1/budgets/{id}/limits/{limitId} | Update existing budget limit.
+*CategoriesApi* | [**delete_category**](docs/CategoriesApi.md#delete_category) | **DELETE** /v1/categories/{id} | Delete a category.
+*CategoriesApi* | [**get_category**](docs/CategoriesApi.md#get_category) | **GET** /v1/categories/{id} | Get a single category.
+*CategoriesApi* | [**list_attachment_by_category**](docs/CategoriesApi.md#list_attachment_by_category) | **GET** /v1/categories/{id}/attachments | Lists all attachments.
+*CategoriesApi* | [**list_category**](docs/CategoriesApi.md#list_category) | **GET** /v1/categories | List all categories.
+*CategoriesApi* | [**list_transaction_by_category**](docs/CategoriesApi.md#list_transaction_by_category) | **GET** /v1/categories/{id}/transactions | List all transactions in a category.
+*CategoriesApi* | [**store_category**](docs/CategoriesApi.md#store_category) | **POST** /v1/categories | Store a new category
+*CategoriesApi* | [**update_category**](docs/CategoriesApi.md#update_category) | **PUT** /v1/categories/{id} | Update existing category.
+*ChartsApi* | [**get_chart_account_overview**](docs/ChartsApi.md#get_chart_account_overview) | **GET** /v1/chart/account/overview | Dashboard chart with asset account balance information.
+*ConfigurationApi* | [**get_configuration**](docs/ConfigurationApi.md#get_configuration) | **GET** /v1/configuration | Get Firefly III system configuration values.
+*ConfigurationApi* | [**get_single_configuration**](docs/ConfigurationApi.md#get_single_configuration) | **GET** /v1/configuration/{name} | Get a single Firefly III system configuration value
+*ConfigurationApi* | [**set_configuration**](docs/ConfigurationApi.md#set_configuration) | **PUT** /v1/configuration/{name} | Update configuration value
+*CurrenciesApi* | [**default_currency**](docs/CurrenciesApi.md#default_currency) | **POST** /v1/currencies/{code}/default | Make currency default currency.
+*CurrenciesApi* | [**delete_currency**](docs/CurrenciesApi.md#delete_currency) | **DELETE** /v1/currencies/{code} | Delete a currency.
+*CurrenciesApi* | [**disable_currency**](docs/CurrenciesApi.md#disable_currency) | **POST** /v1/currencies/{code}/disable | Disable a currency.
+*CurrenciesApi* | [**enable_currency**](docs/CurrenciesApi.md#enable_currency) | **POST** /v1/currencies/{code}/enable | Enable a single currency.
+*CurrenciesApi* | [**get_currency**](docs/CurrenciesApi.md#get_currency) | **GET** /v1/currencies/{code} | Get a single currency.
+*CurrenciesApi* | [**get_default_currency**](docs/CurrenciesApi.md#get_default_currency) | **GET** /v1/currencies/default | Get the user's default currency.
+*CurrenciesApi* | [**list_account_by_currency**](docs/CurrenciesApi.md#list_account_by_currency) | **GET** /v1/currencies/{code}/accounts | List all accounts with this currency.
+*CurrenciesApi* | [**list_available_budget_by_currency**](docs/CurrenciesApi.md#list_available_budget_by_currency) | **GET** /v1/currencies/{code}/available-budgets | List all available budgets with this currency.
+*CurrenciesApi* | [**list_bill_by_currency**](docs/CurrenciesApi.md#list_bill_by_currency) | **GET** /v1/currencies/{code}/bills | List all bills with this currency.
+*CurrenciesApi* | [**list_budget_limit_by_currency**](docs/CurrenciesApi.md#list_budget_limit_by_currency) | **GET** /v1/currencies/{code}/budget_limits | List all budget limits with this currency
+*CurrenciesApi* | [**list_currency**](docs/CurrenciesApi.md#list_currency) | **GET** /v1/currencies | List all currencies.
+*CurrenciesApi* | [**list_recurrence_by_currency**](docs/CurrenciesApi.md#list_recurrence_by_currency) | **GET** /v1/currencies/{code}/recurrences | List all recurring transactions with this currency.
+*CurrenciesApi* | [**list_rule_by_currency**](docs/CurrenciesApi.md#list_rule_by_currency) | **GET** /v1/currencies/{code}/rules | List all rules with this currency.
+*CurrenciesApi* | [**list_transaction_by_currency**](docs/CurrenciesApi.md#list_transaction_by_currency) | **GET** /v1/currencies/{code}/transactions | List all transactions with this currency.
+*CurrenciesApi* | [**store_currency**](docs/CurrenciesApi.md#store_currency) | **POST** /v1/currencies | Store a new currency
+*CurrenciesApi* | [**update_currency**](docs/CurrenciesApi.md#update_currency) | **PUT** /v1/currencies/{code} | Update existing currency.
+*DataApi* | [**bulk_update_transactions**](docs/DataApi.md#bulk_update_transactions) | **POST** /v1/data/bulk/transactions | Bulk update transaction properties. For more information, see https://docs.firefly-iii.org/references/firefly-iii/api/specials/
+*DataApi* | [**destroy_data**](docs/DataApi.md#destroy_data) | **DELETE** /v1/data/destroy | Endpoint to destroy user data
+*DataApi* | [**export_accounts**](docs/DataApi.md#export_accounts) | **GET** /v1/data/export/accounts | Export account data from Firefly III
+*DataApi* | [**export_bills**](docs/DataApi.md#export_bills) | **GET** /v1/data/export/bills | Export bills from Firefly III
+*DataApi* | [**export_budgets**](docs/DataApi.md#export_budgets) | **GET** /v1/data/export/budgets | Export budgets and budget amount data from Firefly III
+*DataApi* | [**export_categories**](docs/DataApi.md#export_categories) | **GET** /v1/data/export/categories | Export category data from Firefly III
+*DataApi* | [**export_piggies**](docs/DataApi.md#export_piggies) | **GET** /v1/data/export/piggy-banks | Export piggy banks from Firefly III
+*DataApi* | [**export_recurring**](docs/DataApi.md#export_recurring) | **GET** /v1/data/export/recurring | Export recurring transaction data from Firefly III
+*DataApi* | [**export_rules**](docs/DataApi.md#export_rules) | **GET** /v1/data/export/rules | Export rule groups and rule data from Firefly III
+*DataApi* | [**export_tags**](docs/DataApi.md#export_tags) | **GET** /v1/data/export/tags | Export tag data from Firefly III
+*DataApi* | [**export_transactions**](docs/DataApi.md#export_transactions) | **GET** /v1/data/export/transactions | Export transaction data from Firefly III
+*DataApi* | [**purge_data**](docs/DataApi.md#purge_data) | **DELETE** /v1/data/purge | Endpoint to purge user data
+*InsightApi* | [**insight_expense_asset**](docs/InsightApi.md#insight_expense_asset) | **GET** /v1/insight/expense/asset | Insight into expenses, grouped by asset account.
+*InsightApi* | [**insight_expense_bill**](docs/InsightApi.md#insight_expense_bill) | **GET** /v1/insight/expense/bill | Insight into expenses, grouped by bill.
+*InsightApi* | [**insight_expense_budget**](docs/InsightApi.md#insight_expense_budget) | **GET** /v1/insight/expense/budget | Insight into expenses, grouped by budget.
+*InsightApi* | [**insight_expense_category**](docs/InsightApi.md#insight_expense_category) | **GET** /v1/insight/expense/category | Insight into expenses, grouped by category.
+*InsightApi* | [**insight_expense_expense**](docs/InsightApi.md#insight_expense_expense) | **GET** /v1/insight/expense/expense | Insight into expenses, grouped by expense account.
+*InsightApi* | [**insight_expense_no_bill**](docs/InsightApi.md#insight_expense_no_bill) | **GET** /v1/insight/expense/no-bill | Insight into expenses, without bill.
+*InsightApi* | [**insight_expense_no_budget**](docs/InsightApi.md#insight_expense_no_budget) | **GET** /v1/insight/expense/no-budget | Insight into expenses, without budget.
+*InsightApi* | [**insight_expense_no_category**](docs/InsightApi.md#insight_expense_no_category) | **GET** /v1/insight/expense/no-category | Insight into expenses, without category.
+*InsightApi* | [**insight_expense_no_tag**](docs/InsightApi.md#insight_expense_no_tag) | **GET** /v1/insight/expense/no-tag | Insight into expenses, without tag.
+*InsightApi* | [**insight_expense_tag**](docs/InsightApi.md#insight_expense_tag) | **GET** /v1/insight/expense/tag | Insight into expenses, grouped by tag.
+*InsightApi* | [**insight_expense_total**](docs/InsightApi.md#insight_expense_total) | **GET** /v1/insight/expense/total | Insight into total expenses.
+*InsightApi* | [**insight_income_asset**](docs/InsightApi.md#insight_income_asset) | **GET** /v1/insight/income/asset | Insight into income, grouped by asset account.
+*InsightApi* | [**insight_income_category**](docs/InsightApi.md#insight_income_category) | **GET** /v1/insight/income/category | Insight into income, grouped by category.
+*InsightApi* | [**insight_income_no_category**](docs/InsightApi.md#insight_income_no_category) | **GET** /v1/insight/income/no-category | Insight into income, without category.
+*InsightApi* | [**insight_income_no_tag**](docs/InsightApi.md#insight_income_no_tag) | **GET** /v1/insight/income/no-tag | Insight into income, without tag.
+*InsightApi* | [**insight_income_revenue**](docs/InsightApi.md#insight_income_revenue) | **GET** /v1/insight/income/revenue | Insight into income, grouped by revenue account.
+*InsightApi* | [**insight_income_tag**](docs/InsightApi.md#insight_income_tag) | **GET** /v1/insight/income/tag | Insight into income, grouped by tag.
+*InsightApi* | [**insight_income_total**](docs/InsightApi.md#insight_income_total) | **GET** /v1/insight/income/total | Insight into total income.
+*InsightApi* | [**insight_transfer_category**](docs/InsightApi.md#insight_transfer_category) | **GET** /v1/insight/transfer/category | Insight into transfers, grouped by category.
+*InsightApi* | [**insight_transfer_no_category**](docs/InsightApi.md#insight_transfer_no_category) | **GET** /v1/insight/transfer/no-category | Insight into transfers, without category.
+*InsightApi* | [**insight_transfer_no_tag**](docs/InsightApi.md#insight_transfer_no_tag) | **GET** /v1/insight/transfer/no-tag | Insight into expenses, without tag.
+*InsightApi* | [**insight_transfer_tag**](docs/InsightApi.md#insight_transfer_tag) | **GET** /v1/insight/transfer/tag | Insight into transfers, grouped by tag.
+*InsightApi* | [**insight_transfer_total**](docs/InsightApi.md#insight_transfer_total) | **GET** /v1/insight/transfer/total | Insight into total transfers.
+*InsightApi* | [**insight_transfers**](docs/InsightApi.md#insight_transfers) | **GET** /v1/insight/transfer/asset | Insight into transfers, grouped by account.
+*LinksApi* | [**delete_link_type**](docs/LinksApi.md#delete_link_type) | **DELETE** /v1/link-types/{id} | Permanently delete link type.
+*LinksApi* | [**delete_transaction_link**](docs/LinksApi.md#delete_transaction_link) | **DELETE** /v1/transaction-links/{id} | Permanently delete link between transactions.
+*LinksApi* | [**get_link_type**](docs/LinksApi.md#get_link_type) | **GET** /v1/link-types/{id} | Get single a link type.
+*LinksApi* | [**get_transaction_link**](docs/LinksApi.md#get_transaction_link) | **GET** /v1/transaction-links/{id} | Get a single link.
+*LinksApi* | [**list_link_type**](docs/LinksApi.md#list_link_type) | **GET** /v1/link-types | List all types of links.
+*LinksApi* | [**list_transaction_by_link_type**](docs/LinksApi.md#list_transaction_by_link_type) | **GET** /v1/link-types/{id}/transactions | List all transactions under this link type.
+*LinksApi* | [**list_transaction_link**](docs/LinksApi.md#list_transaction_link) | **GET** /v1/transaction-links | List all transaction links.
+*LinksApi* | [**store_link_type**](docs/LinksApi.md#store_link_type) | **POST** /v1/link-types | Create a new link type
+*LinksApi* | [**store_transaction_link**](docs/LinksApi.md#store_transaction_link) | **POST** /v1/transaction-links | Create a new link between transactions
+*LinksApi* | [**update_link_type**](docs/LinksApi.md#update_link_type) | **PUT** /v1/link-types/{id} | Update existing link type.
+*LinksApi* | [**update_transaction_link**](docs/LinksApi.md#update_transaction_link) | **PUT** /v1/transaction-links/{id} | Update an existing link between transactions.
+*ObjectGroupsApi* | [**delete_object_group**](docs/ObjectGroupsApi.md#delete_object_group) | **DELETE** /v1/object-groups/{id} | Delete a object group.
+*ObjectGroupsApi* | [**get_object_group**](docs/ObjectGroupsApi.md#get_object_group) | **GET** /v1/object-groups/{id} | Get a single object group.
+*ObjectGroupsApi* | [**list_bill_by_object_group**](docs/ObjectGroupsApi.md#list_bill_by_object_group) | **GET** /v1/object-groups/{id}/bills | List all bills with this object group.
+*ObjectGroupsApi* | [**list_object_groups**](docs/ObjectGroupsApi.md#list_object_groups) | **GET** /v1/object-groups | List all oject groups.
+*ObjectGroupsApi* | [**list_piggy_bank_by_object_group**](docs/ObjectGroupsApi.md#list_piggy_bank_by_object_group) | **GET** /v1/object-groups/{id}/piggy-banks | List all piggy banks related to the object group.
+*ObjectGroupsApi* | [**update_object_group**](docs/ObjectGroupsApi.md#update_object_group) | **PUT** /v1/object-groups/{id} | Update existing object group.
+*PiggyBanksApi* | [**delete_piggy_bank**](docs/PiggyBanksApi.md#delete_piggy_bank) | **DELETE** /v1/piggy-banks/{id} | Delete a piggy bank.
+*PiggyBanksApi* | [**get_piggy_bank**](docs/PiggyBanksApi.md#get_piggy_bank) | **GET** /v1/piggy-banks/{id} | Get a single piggy bank.
+*PiggyBanksApi* | [**list_attachment_by_piggy_bank**](docs/PiggyBanksApi.md#list_attachment_by_piggy_bank) | **GET** /v1/piggy-banks/{id}/attachments | Lists all attachments.
+*PiggyBanksApi* | [**list_event_by_piggy_bank**](docs/PiggyBanksApi.md#list_event_by_piggy_bank) | **GET** /v1/piggy-banks/{id}/events | List all events linked to a piggy bank.
+*PiggyBanksApi* | [**list_piggy_bank**](docs/PiggyBanksApi.md#list_piggy_bank) | **GET** /v1/piggy-banks | List all piggy banks.
+*PiggyBanksApi* | [**store_piggy_bank**](docs/PiggyBanksApi.md#store_piggy_bank) | **POST** /v1/piggy-banks | Store a new piggy bank
+*PiggyBanksApi* | [**update_piggy_bank**](docs/PiggyBanksApi.md#update_piggy_bank) | **PUT** /v1/piggy-banks/{id} | Update existing piggy bank.
+*PreferencesApi* | [**get_preference**](docs/PreferencesApi.md#get_preference) | **GET** /v1/preferences/{name} | Return a single preference.
+*PreferencesApi* | [**list_preference**](docs/PreferencesApi.md#list_preference) | **GET** /v1/preferences | List all users preferences.
+*PreferencesApi* | [**store_preference**](docs/PreferencesApi.md#store_preference) | **POST** /v1/preferences | Store a new preference for this user.
+*PreferencesApi* | [**update_preference**](docs/PreferencesApi.md#update_preference) | **PUT** /v1/preferences/{name} | Update preference
+*RecurrencesApi* | [**delete_recurrence**](docs/RecurrencesApi.md#delete_recurrence) | **DELETE** /v1/recurrences/{id} | Delete a recurring transaction.
+*RecurrencesApi* | [**get_recurrence**](docs/RecurrencesApi.md#get_recurrence) | **GET** /v1/recurrences/{id} | Get a single recurring transaction.
+*RecurrencesApi* | [**list_recurrence**](docs/RecurrencesApi.md#list_recurrence) | **GET** /v1/recurrences | List all recurring transactions.
+*RecurrencesApi* | [**list_transaction_by_recurrence**](docs/RecurrencesApi.md#list_transaction_by_recurrence) | **GET** /v1/recurrences/{id}/transactions | List all transactions created by a recurring transaction.
+*RecurrencesApi* | [**store_recurrence**](docs/RecurrencesApi.md#store_recurrence) | **POST** /v1/recurrences | Store a new recurring transaction
+*RecurrencesApi* | [**update_recurrence**](docs/RecurrencesApi.md#update_recurrence) | **PUT** /v1/recurrences/{id} | Update existing recurring transaction.
+*RuleGroupsApi* | [**delete_rule_group**](docs/RuleGroupsApi.md#delete_rule_group) | **DELETE** /v1/rule-groups/{id} | Delete a rule group.
+*RuleGroupsApi* | [**fire_rule_group**](docs/RuleGroupsApi.md#fire_rule_group) | **POST** /v1/rule-groups/{id}/trigger | Fire the rule group on your transactions.
+*RuleGroupsApi* | [**get_rule_group**](docs/RuleGroupsApi.md#get_rule_group) | **GET** /v1/rule-groups/{id} | Get a single rule group.
+*RuleGroupsApi* | [**list_rule_by_group**](docs/RuleGroupsApi.md#list_rule_by_group) | **GET** /v1/rule-groups/{id}/rules | List rules in this rule group.
+*RuleGroupsApi* | [**list_rule_group**](docs/RuleGroupsApi.md#list_rule_group) | **GET** /v1/rule-groups | List all rule groups.
+*RuleGroupsApi* | [**store_rule_group**](docs/RuleGroupsApi.md#store_rule_group) | **POST** /v1/rule-groups | Store a new rule group.
+*RuleGroupsApi* | [**test_rule_group**](docs/RuleGroupsApi.md#test_rule_group) | **GET** /v1/rule-groups/{id}/test | Test which transactions would be hit by the rule group. No changes will be made.
+*RuleGroupsApi* | [**update_rule_group**](docs/RuleGroupsApi.md#update_rule_group) | **PUT** /v1/rule-groups/{id} | Update existing rule group.
+*RulesApi* | [**delete_rule**](docs/RulesApi.md#delete_rule) | **DELETE** /v1/rules/{id} | Delete an rule.
+*RulesApi* | [**fire_rule**](docs/RulesApi.md#fire_rule) | **POST** /v1/rules/{id}/trigger | Fire the rule on your transactions.
+*RulesApi* | [**get_rule**](docs/RulesApi.md#get_rule) | **GET** /v1/rules/{id} | Get a single rule.
+*RulesApi* | [**list_rule**](docs/RulesApi.md#list_rule) | **GET** /v1/rules | List all rules.
+*RulesApi* | [**store_rule**](docs/RulesApi.md#store_rule) | **POST** /v1/rules | Store a new rule
+*RulesApi* | [**test_rule**](docs/RulesApi.md#test_rule) | **GET** /v1/rules/{id}/test | Test which transactions would be hit by the rule. No changes will be made.
+*RulesApi* | [**update_rule**](docs/RulesApi.md#update_rule) | **PUT** /v1/rules/{id} | Update existing rule.
+*SearchApi* | [**search_accounts**](docs/SearchApi.md#search_accounts) | **GET** /v1/search/accounts | Search for accounts
+*SearchApi* | [**search_transactions**](docs/SearchApi.md#search_transactions) | **GET** /v1/search/transactions | Search for transactions
+*SummaryApi* | [**get_basic_summary**](docs/SummaryApi.md#get_basic_summary) | **GET** /v1/summary/basic | Returns basic sums of the users data.
+*TagsApi* | [**delete_tag**](docs/TagsApi.md#delete_tag) | **DELETE** /v1/tags/{tag} | Delete an tag.
+*TagsApi* | [**get_tag**](docs/TagsApi.md#get_tag) | **GET** /v1/tags/{tag} | Get a single tag.
+*TagsApi* | [**list_attachment_by_tag**](docs/TagsApi.md#list_attachment_by_tag) | **GET** /v1/tags/{tag}/attachments | Lists all attachments.
+*TagsApi* | [**list_tag**](docs/TagsApi.md#list_tag) | **GET** /v1/tags | List all tags.
+*TagsApi* | [**list_transaction_by_tag**](docs/TagsApi.md#list_transaction_by_tag) | **GET** /v1/tags/{tag}/transactions | List all transactions with this tag.
+*TagsApi* | [**store_tag**](docs/TagsApi.md#store_tag) | **POST** /v1/tags | Store a new tag
+*TagsApi* | [**update_tag**](docs/TagsApi.md#update_tag) | **PUT** /v1/tags/{tag} | Update existing tag.
+*TransactionsApi* | [**delete_transaction**](docs/TransactionsApi.md#delete_transaction) | **DELETE** /v1/transactions/{id} | Delete a transaction.
+*TransactionsApi* | [**delete_transaction_journal**](docs/TransactionsApi.md#delete_transaction_journal) | **DELETE** /v1/transaction-journals/{id} | Delete split from transaction
+*TransactionsApi* | [**get_transaction**](docs/TransactionsApi.md#get_transaction) | **GET** /v1/transactions/{id} | Get a single transaction.
+*TransactionsApi* | [**get_transaction_by_journal**](docs/TransactionsApi.md#get_transaction_by_journal) | **GET** /v1/transaction-journals/{id} | Get a single transaction, based on one of the underlying transaction journals (transaction splits).
+*TransactionsApi* | [**list_attachment_by_transaction**](docs/TransactionsApi.md#list_attachment_by_transaction) | **GET** /v1/transactions/{id}/attachments | Lists all attachments.
+*TransactionsApi* | [**list_event_by_transaction**](docs/TransactionsApi.md#list_event_by_transaction) | **GET** /v1/transactions/{id}/piggy-bank-events | Lists all piggy bank events.
+*TransactionsApi* | [**list_links_by_journal**](docs/TransactionsApi.md#list_links_by_journal) | **GET** /v1/transaction-journals/{id}/links | Lists all the transaction links for an individual journal (individual split).
+*TransactionsApi* | [**list_transaction**](docs/TransactionsApi.md#list_transaction) | **GET** /v1/transactions | List all the user's transactions. 
+*TransactionsApi* | [**store_transaction**](docs/TransactionsApi.md#store_transaction) | **POST** /v1/transactions | Store a new transaction
+*TransactionsApi* | [**update_transaction**](docs/TransactionsApi.md#update_transaction) | **PUT** /v1/transactions/{id} | Update existing transaction. For more information, see https://docs.firefly-iii.org/references/firefly-iii/api/specials/
+*UsersApi* | [**delete_user**](docs/UsersApi.md#delete_user) | **DELETE** /v1/users/{id} | Delete a user.
+*UsersApi* | [**get_user**](docs/UsersApi.md#get_user) | **GET** /v1/users/{id} | Get a single user.
+*UsersApi* | [**list_user**](docs/UsersApi.md#list_user) | **GET** /v1/users | List all users.
+*UsersApi* | [**store_user**](docs/UsersApi.md#store_user) | **POST** /v1/users | Store a new user
+*UsersApi* | [**update_user**](docs/UsersApi.md#update_user) | **PUT** /v1/users/{id} | Update an existing user's information.
+*WebhooksApi* | [**delete_webhook**](docs/WebhooksApi.md#delete_webhook) | **DELETE** /v1/webhooks/{id} | Delete a webhook.
+*WebhooksApi* | [**delete_webhook_message**](docs/WebhooksApi.md#delete_webhook_message) | **DELETE** /v1/webhooks/{id}/messages/{messageId} | Delete a webhook message.
+*WebhooksApi* | [**delete_webhook_message_attempt**](docs/WebhooksApi.md#delete_webhook_message_attempt) | **DELETE** /v1/webhooks/{id}/messages/{messageId}/attempts/{attemptId} | Delete a webhook attempt.
+*WebhooksApi* | [**get_single_webhook_message**](docs/WebhooksApi.md#get_single_webhook_message) | **GET** /v1/webhooks/{id}/messages/{messageId} | Get a single message from a webhook.
+*WebhooksApi* | [**get_single_webhook_message_attempt**](docs/WebhooksApi.md#get_single_webhook_message_attempt) | **GET** /v1/webhooks/{id}/messages/{messageId}/attempts/{attemptId} | Get a single failed attempt from a single webhook message.
+*WebhooksApi* | [**get_webhook**](docs/WebhooksApi.md#get_webhook) | **GET** /v1/webhooks/{id} | Get a single webhook.
+*WebhooksApi* | [**get_webhook_message_attempts**](docs/WebhooksApi.md#get_webhook_message_attempts) | **GET** /v1/webhooks/{id}/messages/{messageId}/attempts | Get all the failed attempts of a single webhook message.
+*WebhooksApi* | [**get_webhook_messages**](docs/WebhooksApi.md#get_webhook_messages) | **GET** /v1/webhooks/{id}/messages | Get all the messages of a single webhook.
+*WebhooksApi* | [**list_webhook**](docs/WebhooksApi.md#list_webhook) | **GET** /v1/webhooks | List all webhooks.
+*WebhooksApi* | [**store_webhook**](docs/WebhooksApi.md#store_webhook) | **POST** /v1/webhooks | Store a new webhook
+*WebhooksApi* | [**submit_webook**](docs/WebhooksApi.md#submit_webook) | **POST** /v1/webhooks/{id}/submit | Submit messages for a webhook.
+*WebhooksApi* | [**trigger_transaction_webhook**](docs/WebhooksApi.md#trigger_transaction_webhook) | **POST** /v1/webhooks/{id}/trigger-transaction/{transactionId} | Trigger webhook for a given transaction.
+*WebhooksApi* | [**update_webhook**](docs/WebhooksApi.md#update_webhook) | **PUT** /v1/webhooks/{id} | Update existing webhook.
+
+
+## Documentation For Models
+
+ - [Account](docs/Account.md)
+ - [AccountArray](docs/AccountArray.md)
+ - [AccountRead](docs/AccountRead.md)
+ - [AccountRoleProperty](docs/AccountRoleProperty.md)
+ - [AccountSearchFieldFilter](docs/AccountSearchFieldFilter.md)
+ - [AccountSingle](docs/AccountSingle.md)
+ - [AccountStore](docs/AccountStore.md)
+ - [AccountTypeFilter](docs/AccountTypeFilter.md)
+ - [AccountTypeProperty](docs/AccountTypeProperty.md)
+ - [AccountUpdate](docs/AccountUpdate.md)
+ - [AttachableType](docs/AttachableType.md)
+ - [Attachment](docs/Attachment.md)
+ - [AttachmentArray](docs/AttachmentArray.md)
+ - [AttachmentRead](docs/AttachmentRead.md)
+ - [AttachmentSingle](docs/AttachmentSingle.md)
+ - [AttachmentStore](docs/AttachmentStore.md)
+ - [AttachmentUpdate](docs/AttachmentUpdate.md)
+ - [AutoBudgetPeriod](docs/AutoBudgetPeriod.md)
+ - [AutoBudgetType](docs/AutoBudgetType.md)
+ - [AutocompleteAccount](docs/AutocompleteAccount.md)
+ - [AutocompleteBill](docs/AutocompleteBill.md)
+ - [AutocompleteBudget](docs/AutocompleteBudget.md)
+ - [AutocompleteCategory](docs/AutocompleteCategory.md)
+ - [AutocompleteCurrency](docs/AutocompleteCurrency.md)
+ - [AutocompleteCurrencyCode](docs/AutocompleteCurrencyCode.md)
+ - [AutocompleteObjectGroup](docs/AutocompleteObjectGroup.md)
+ - [AutocompletePiggy](docs/AutocompletePiggy.md)
+ - [AutocompletePiggyBalance](docs/AutocompletePiggyBalance.md)
+ - [AutocompleteRecurrence](docs/AutocompleteRecurrence.md)
+ - [AutocompleteRule](docs/AutocompleteRule.md)
+ - [AutocompleteRuleGroup](docs/AutocompleteRuleGroup.md)
+ - [AutocompleteTag](docs/AutocompleteTag.md)
+ - [AutocompleteTransaction](docs/AutocompleteTransaction.md)
+ - [AutocompleteTransactionId](docs/AutocompleteTransactionId.md)
+ - [AutocompleteTransactionType](docs/AutocompleteTransactionType.md)
+ - [AvailableBudget](docs/AvailableBudget.md)
+ - [AvailableBudgetArray](docs/AvailableBudgetArray.md)
+ - [AvailableBudgetRead](docs/AvailableBudgetRead.md)
+ - [AvailableBudgetSingle](docs/AvailableBudgetSingle.md)
+ - [BadRequestResponse](docs/BadRequestResponse.md)
+ - [BasicSummaryEntry](docs/BasicSummaryEntry.md)
+ - [Bill](docs/Bill.md)
+ - [BillArray](docs/BillArray.md)
+ - [BillPaidDatesInner](docs/BillPaidDatesInner.md)
+ - [BillRead](docs/BillRead.md)
+ - [BillRepeatFrequency](docs/BillRepeatFrequency.md)
+ - [BillSingle](docs/BillSingle.md)
+ - [BillStore](docs/BillStore.md)
+ - [BillUpdate](docs/BillUpdate.md)
+ - [Budget](docs/Budget.md)
+ - [BudgetArray](docs/BudgetArray.md)
+ - [BudgetLimit](docs/BudgetLimit.md)
+ - [BudgetLimitArray](docs/BudgetLimitArray.md)
+ - [BudgetLimitRead](docs/BudgetLimitRead.md)
+ - [BudgetLimitSingle](docs/BudgetLimitSingle.md)
+ - [BudgetLimitStore](docs/BudgetLimitStore.md)
+ - [BudgetRead](docs/BudgetRead.md)
+ - [BudgetSingle](docs/BudgetSingle.md)
+ - [BudgetSpent](docs/BudgetSpent.md)
+ - [BudgetStore](docs/BudgetStore.md)
+ - [BudgetUpdate](docs/BudgetUpdate.md)
+ - [Category](docs/Category.md)
+ - [CategoryArray](docs/CategoryArray.md)
+ - [CategoryEarned](docs/CategoryEarned.md)
+ - [CategoryRead](docs/CategoryRead.md)
+ - [CategorySingle](docs/CategorySingle.md)
+ - [CategorySpent](docs/CategorySpent.md)
+ - [CategoryUpdate](docs/CategoryUpdate.md)
+ - [ChartDataPoint](docs/ChartDataPoint.md)
+ - [ChartDataSet](docs/ChartDataSet.md)
+ - [ConfigValueFilter](docs/ConfigValueFilter.md)
+ - [ConfigValueUpdateFilter](docs/ConfigValueUpdateFilter.md)
+ - [Configuration](docs/Configuration.md)
+ - [ConfigurationSingle](docs/ConfigurationSingle.md)
+ - [ConfigurationUpdate](docs/ConfigurationUpdate.md)
+ - [CreditCardTypeProperty](docs/CreditCardTypeProperty.md)
+ - [CronResult](docs/CronResult.md)
+ - [CronResultRow](docs/CronResultRow.md)
+ - [Currency](docs/Currency.md)
+ - [CurrencyArray](docs/CurrencyArray.md)
+ - [CurrencyRead](docs/CurrencyRead.md)
+ - [CurrencySingle](docs/CurrencySingle.md)
+ - [CurrencyStore](docs/CurrencyStore.md)
+ - [CurrencyUpdate](docs/CurrencyUpdate.md)
+ - [DataDestroyObject](docs/DataDestroyObject.md)
+ - [ExportFileFilter](docs/ExportFileFilter.md)
+ - [InsightGroupEntry](docs/InsightGroupEntry.md)
+ - [InsightTotalEntry](docs/InsightTotalEntry.md)
+ - [InsightTransferEntry](docs/InsightTransferEntry.md)
+ - [InterestPeriodProperty](docs/InterestPeriodProperty.md)
+ - [InternalExceptionResponse](docs/InternalExceptionResponse.md)
+ - [LiabilityDirectionProperty](docs/LiabilityDirectionProperty.md)
+ - [LiabilityTypeProperty](docs/LiabilityTypeProperty.md)
+ - [LinkType](docs/LinkType.md)
+ - [LinkTypeArray](docs/LinkTypeArray.md)
+ - [LinkTypeRead](docs/LinkTypeRead.md)
+ - [LinkTypeSingle](docs/LinkTypeSingle.md)
+ - [LinkTypeUpdate](docs/LinkTypeUpdate.md)
+ - [Meta](docs/Meta.md)
+ - [MetaPagination](docs/MetaPagination.md)
+ - [NotFoundResponse](docs/NotFoundResponse.md)
+ - [ObjectGroup](docs/ObjectGroup.md)
+ - [ObjectGroupArray](docs/ObjectGroupArray.md)
+ - [ObjectGroupRead](docs/ObjectGroupRead.md)
+ - [ObjectGroupSingle](docs/ObjectGroupSingle.md)
+ - [ObjectGroupUpdate](docs/ObjectGroupUpdate.md)
+ - [ObjectLink](docs/ObjectLink.md)
+ - [ObjectLink0](docs/ObjectLink0.md)
+ - [PageLink](docs/PageLink.md)
+ - [PiggyBank](docs/PiggyBank.md)
+ - [PiggyBankArray](docs/PiggyBankArray.md)
+ - [PiggyBankEvent](docs/PiggyBankEvent.md)
+ - [PiggyBankEventArray](docs/PiggyBankEventArray.md)
+ - [PiggyBankEventRead](docs/PiggyBankEventRead.md)
+ - [PiggyBankRead](docs/PiggyBankRead.md)
+ - [PiggyBankSingle](docs/PiggyBankSingle.md)
+ - [PiggyBankStore](docs/PiggyBankStore.md)
+ - [PiggyBankUpdate](docs/PiggyBankUpdate.md)
+ - [PolymorphicProperty](docs/PolymorphicProperty.md)
+ - [Preference](docs/Preference.md)
+ - [PreferenceArray](docs/PreferenceArray.md)
+ - [PreferenceRead](docs/PreferenceRead.md)
+ - [PreferenceSingle](docs/PreferenceSingle.md)
+ - [PreferenceUpdate](docs/PreferenceUpdate.md)
+ - [Recurrence](docs/Recurrence.md)
+ - [RecurrenceArray](docs/RecurrenceArray.md)
+ - [RecurrenceRead](docs/RecurrenceRead.md)
+ - [RecurrenceRepetition](docs/RecurrenceRepetition.md)
+ - [RecurrenceRepetitionStore](docs/RecurrenceRepetitionStore.md)
+ - [RecurrenceRepetitionType](docs/RecurrenceRepetitionType.md)
+ - [RecurrenceRepetitionUpdate](docs/RecurrenceRepetitionUpdate.md)
+ - [RecurrenceSingle](docs/RecurrenceSingle.md)
+ - [RecurrenceStore](docs/RecurrenceStore.md)
+ - [RecurrenceTransaction](docs/RecurrenceTransaction.md)
+ - [RecurrenceTransactionStore](docs/RecurrenceTransactionStore.md)
+ - [RecurrenceTransactionType](docs/RecurrenceTransactionType.md)
+ - [RecurrenceTransactionUpdate](docs/RecurrenceTransactionUpdate.md)
+ - [RecurrenceUpdate](docs/RecurrenceUpdate.md)
+ - [Rule](docs/Rule.md)
+ - [RuleAction](docs/RuleAction.md)
+ - [RuleActionKeyword](docs/RuleActionKeyword.md)
+ - [RuleActionStore](docs/RuleActionStore.md)
+ - [RuleActionUpdate](docs/RuleActionUpdate.md)
+ - [RuleArray](docs/RuleArray.md)
+ - [RuleGroup](docs/RuleGroup.md)
+ - [RuleGroupArray](docs/RuleGroupArray.md)
+ - [RuleGroupRead](docs/RuleGroupRead.md)
+ - [RuleGroupSingle](docs/RuleGroupSingle.md)
+ - [RuleGroupStore](docs/RuleGroupStore.md)
+ - [RuleGroupUpdate](docs/RuleGroupUpdate.md)
+ - [RuleRead](docs/RuleRead.md)
+ - [RuleSingle](docs/RuleSingle.md)
+ - [RuleStore](docs/RuleStore.md)
+ - [RuleTrigger](docs/RuleTrigger.md)
+ - [RuleTriggerKeyword](docs/RuleTriggerKeyword.md)
+ - [RuleTriggerStore](docs/RuleTriggerStore.md)
+ - [RuleTriggerType](docs/RuleTriggerType.md)
+ - [RuleTriggerUpdate](docs/RuleTriggerUpdate.md)
+ - [RuleUpdate](docs/RuleUpdate.md)
+ - [ShortAccountTypeProperty](docs/ShortAccountTypeProperty.md)
+ - [SystemInfo](docs/SystemInfo.md)
+ - [SystemInfoData](docs/SystemInfoData.md)
+ - [TagArray](docs/TagArray.md)
+ - [TagModel](docs/TagModel.md)
+ - [TagModelStore](docs/TagModelStore.md)
+ - [TagModelUpdate](docs/TagModelUpdate.md)
+ - [TagRead](docs/TagRead.md)
+ - [TagSingle](docs/TagSingle.md)
+ - [Transaction](docs/Transaction.md)
+ - [TransactionArray](docs/TransactionArray.md)
+ - [TransactionLink](docs/TransactionLink.md)
+ - [TransactionLinkArray](docs/TransactionLinkArray.md)
+ - [TransactionLinkRead](docs/TransactionLinkRead.md)
+ - [TransactionLinkSingle](docs/TransactionLinkSingle.md)
+ - [TransactionLinkStore](docs/TransactionLinkStore.md)
+ - [TransactionLinkUpdate](docs/TransactionLinkUpdate.md)
+ - [TransactionRead](docs/TransactionRead.md)
+ - [TransactionSingle](docs/TransactionSingle.md)
+ - [TransactionSplit](docs/TransactionSplit.md)
+ - [TransactionSplitStore](docs/TransactionSplitStore.md)
+ - [TransactionSplitUpdate](docs/TransactionSplitUpdate.md)
+ - [TransactionStore](docs/TransactionStore.md)
+ - [TransactionTypeFilter](docs/TransactionTypeFilter.md)
+ - [TransactionTypeProperty](docs/TransactionTypeProperty.md)
+ - [TransactionUpdate](docs/TransactionUpdate.md)
+ - [UnauthenticatedResponse](docs/UnauthenticatedResponse.md)
+ - [User](docs/User.md)
+ - [UserArray](docs/UserArray.md)
+ - [UserBlockedCodeProperty](docs/UserBlockedCodeProperty.md)
+ - [UserRead](docs/UserRead.md)
+ - [UserRoleProperty](docs/UserRoleProperty.md)
+ - [UserSingle](docs/UserSingle.md)
+ - [ValidationErrorResponse](docs/ValidationErrorResponse.md)
+ - [ValidationErrorResponseErrors](docs/ValidationErrorResponseErrors.md)
+ - [Webhook](docs/Webhook.md)
+ - [WebhookArray](docs/WebhookArray.md)
+ - [WebhookAttempt](docs/WebhookAttempt.md)
+ - [WebhookAttemptArray](docs/WebhookAttemptArray.md)
+ - [WebhookAttemptRead](docs/WebhookAttemptRead.md)
+ - [WebhookAttemptSingle](docs/WebhookAttemptSingle.md)
+ - [WebhookDelivery](docs/WebhookDelivery.md)
+ - [WebhookMessage](docs/WebhookMessage.md)
+ - [WebhookMessageArray](docs/WebhookMessageArray.md)
+ - [WebhookMessageRead](docs/WebhookMessageRead.md)
+ - [WebhookMessageSingle](docs/WebhookMessageSingle.md)
+ - [WebhookRead](docs/WebhookRead.md)
+ - [WebhookResponse](docs/WebhookResponse.md)
+ - [WebhookSingle](docs/WebhookSingle.md)
+ - [WebhookStore](docs/WebhookStore.md)
+ - [WebhookTrigger](docs/WebhookTrigger.md)
+ - [WebhookUpdate](docs/WebhookUpdate.md)
+
+
+To get access to the crate's generated documentation, use:
+
+```
+cargo doc --open
+```
+
+## Author
+
+james@firefly-iii.org
+

firefly-iii-api/docs/AboutApi.md

@@ -0,0 +1,104 @@
+# \AboutApi
+
+All URIs are relative to *https://demo.firefly-iii.org/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_about**](AboutApi.md#get_about) | **GET** /v1/about | System information end point.
+[**get_cron**](AboutApi.md#get_cron) | **GET** /v1/cron/{cliToken} | Cron job endpoint
+[**get_current_user**](AboutApi.md#get_current_user) | **GET** /v1/about/user | Currently authenticated user endpoint.
+
+
+
+## get_about
+
+> models::SystemInfo get_about(x_trace_id)
+System information end point.
+
+Returns general system information and versions of the (supporting) software. 
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+
+### Return type
+
+[**models::SystemInfo**](SystemInfo.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## get_cron
+
+> models::CronResult get_cron(cli_token, x_trace_id, date, force)
+Cron job endpoint
+
+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. 
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**cli_token** | **String** | The CLI token of any user in Firefly III, required to run the cron job. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**date** | Option<**String**> | A date formatted YYYY-MM-DD. This can be used to make the cron job pretend it's running on another day.  |  |
+**force** | Option<**bool**> | Forces the cron job to fire, regardless of whether it has fired before. This may result in double transactions or weird budgets, so be careful.  |  |
+
+### Return type
+
+[**models::CronResult**](CronResult.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## get_current_user
+
+> models::UserSingle get_current_user(x_trace_id)
+Currently authenticated user endpoint.
+
+Returns the currently authenticated user. 
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+
+### Return type
+
+[**models::UserSingle**](UserSingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/vnd.api+json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

firefly-iii-api/docs/Account.md

@@ -0,0 +1,41 @@
+# Account
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | Option<**String**> |  | [optional][readonly]
+**updated_at** | Option<**String**> |  | [optional][readonly]
+**active** | Option<**bool**> | If omitted, defaults to true. | [optional][default to true]
+**order** | Option<**i32**> | Order of the account. Is NULL if account is not asset or liability. | [optional]
+**name** | **String** |  | 
+**r#type** | [**models::ShortAccountTypeProperty**](ShortAccountTypeProperty.md) |  | 
+**account_role** | Option<[**models::AccountRoleProperty**](AccountRoleProperty.md)> |  | [optional]
+**currency_id** | Option<**String**> | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional]
+**currency_code** | Option<**String**> | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional]
+**currency_symbol** | Option<**String**> |  | [optional][readonly]
+**currency_decimal_places** | Option<**i32**> |  | [optional][readonly]
+**current_balance** | Option<**String**> |  | [optional][readonly]
+**current_balance_date** | Option<**String**> | The timestamp for this date is always 23:59:59, to indicate it's the balance at the very END of that particular day. | [optional][readonly]
+**iban** | Option<**String**> |  | [optional]
+**bic** | Option<**String**> |  | [optional]
+**account_number** | Option<**String**> |  | [optional]
+**opening_balance** | Option<**String**> | Represents the opening balance, the initial amount this account holds. | [optional]
+**current_debt** | Option<**String**> | Represents the current debt for liabilities. | [optional]
+**opening_balance_date** | Option<**String**> | Represents the date of the opening balance. | [optional]
+**virtual_balance** | Option<**String**> |  | [optional]
+**include_net_worth** | Option<**bool**> | If omitted, defaults to true. | [optional][default to true]
+**credit_card_type** | Option<[**models::CreditCardTypeProperty**](CreditCardTypeProperty.md)> |  | [optional]
+**monthly_payment_date** | Option<**String**> | Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank. | [optional]
+**liability_type** | Option<[**models::LiabilityTypeProperty**](LiabilityTypeProperty.md)> |  | [optional]
+**liability_direction** | Option<[**models::LiabilityDirectionProperty**](LiabilityDirectionProperty.md)> |  | [optional]
+**interest** | Option<**String**> | Mandatory when type is liability. Interest percentage. | [optional]
+**interest_period** | Option<[**models::InterestPeriodProperty**](InterestPeriodProperty.md)> |  | [optional]
+**notes** | Option<**String**> |  | [optional]
+**latitude** | Option<**f64**> | Latitude of the accounts's location, if applicable. Can be used to draw a map. | [optional]
+**longitude** | Option<**f64**> | Latitude of the accounts's location, if applicable. Can be used to draw a map. | [optional]
+**zoom_level** | Option<**i32**> | 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. | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AccountArray.md

@@ -0,0 +1,12 @@
+# AccountArray
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Vec<models::AccountRead>**](AccountRead.md) |  | 
+**meta** | [**models::Meta**](Meta.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AccountRead.md

@@ -0,0 +1,13 @@
+# AccountRead
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**r#type** | **String** | Immutable value | 
+**id** | **String** |  | 
+**attributes** | [**models::Account**](Account.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AccountRoleProperty.md

@@ -0,0 +1,17 @@
+# AccountRoleProperty
+
+## Enum Variants
+
+| Name | Value |
+|---- | -----|
+| DefaultAsset | defaultAsset |
+| SharedAsset | sharedAsset |
+| SavingAsset | savingAsset |
+| CcAsset | ccAsset |
+| CashWalletAsset | cashWalletAsset |
+| Null | null |
+
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AccountSearchFieldFilter.md

@@ -0,0 +1,16 @@
+# AccountSearchFieldFilter
+
+## Enum Variants
+
+| Name | Value |
+|---- | -----|
+| All | all |
+| Iban | iban |
+| Name | name |
+| Number | number |
+| Id | id |
+
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AccountSingle.md

@@ -0,0 +1,11 @@
+# AccountSingle
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**models::AccountRead**](AccountRead.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AccountStore.md

@@ -0,0 +1,34 @@
+# AccountStore
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**r#type** | [**models::ShortAccountTypeProperty**](ShortAccountTypeProperty.md) |  | 
+**iban** | Option<**String**> |  | [optional]
+**bic** | Option<**String**> |  | [optional]
+**account_number** | Option<**String**> |  | [optional]
+**opening_balance** | Option<**String**> | Represents the opening balance, the initial amount this account holds. | [optional]
+**opening_balance_date** | Option<**String**> | Represents the date of the opening balance. | [optional]
+**virtual_balance** | Option<**String**> |  | [optional]
+**currency_id** | Option<**String**> | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional]
+**currency_code** | Option<**String**> | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional]
+**active** | Option<**bool**> | If omitted, defaults to true. | [optional][default to true]
+**order** | Option<**i32**> | Order of the account | [optional]
+**include_net_worth** | Option<**bool**> | If omitted, defaults to true. | [optional][default to true]
+**account_role** | Option<[**models::AccountRoleProperty**](AccountRoleProperty.md)> |  | [optional]
+**credit_card_type** | Option<[**models::CreditCardTypeProperty**](CreditCardTypeProperty.md)> |  | [optional]
+**monthly_payment_date** | Option<**String**> | Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank. | [optional]
+**liability_type** | Option<[**models::LiabilityTypeProperty**](LiabilityTypeProperty.md)> |  | [optional]
+**liability_direction** | Option<[**models::LiabilityDirectionProperty**](LiabilityDirectionProperty.md)> |  | [optional]
+**interest** | Option<**String**> | Mandatory when type is liability. Interest percentage. | [optional][default to 0]
+**interest_period** | Option<[**models::InterestPeriodProperty**](InterestPeriodProperty.md)> |  | [optional]
+**notes** | Option<**String**> |  | [optional]
+**latitude** | Option<**f64**> | Latitude of the accounts's location, if applicable. Can be used to draw a map. | [optional]
+**longitude** | Option<**f64**> | Latitude of the accounts's location, if applicable. Can be used to draw a map. | [optional]
+**zoom_level** | Option<**i32**> | 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. | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AccountTypeFilter.md

@@ -0,0 +1,32 @@
+# AccountTypeFilter
+
+## Enum Variants
+
+| Name | Value |
+|---- | -----|
+| All | all |
+| Asset | asset |
+| Cash | cash |
+| Expense | expense |
+| Revenue | revenue |
+| Special | special |
+| Hidden | hidden |
+| Liability | liability |
+| Liabilities | liabilities |
+| DefaultAccount | Default account |
+| CashAccount | Cash account |
+| AssetAccount | Asset account |
+| ExpenseAccount | Expense account |
+| RevenueAccount | Revenue account |
+| InitialBalanceAccount | Initial balance account |
+| BeneficiaryAccount | Beneficiary account |
+| ImportAccount | Import account |
+| ReconciliationAccount | Reconciliation account |
+| Loan | Loan |
+| Debt | Debt |
+| Mortgage | Mortgage |
+
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AccountTypeProperty.md

@@ -0,0 +1,23 @@
+# AccountTypeProperty
+
+## Enum Variants
+
+| Name | Value |
+|---- | -----|
+| DefaultAccount | Default account |
+| CashAccount | Cash account |
+| AssetAccount | Asset account |
+| ExpenseAccount | Expense account |
+| RevenueAccount | Revenue account |
+| InitialBalanceAccount | Initial balance account |
+| BeneficiaryAccount | Beneficiary account |
+| ImportAccount | Import account |
+| ReconciliationAccount | Reconciliation account |
+| Loan | Loan |
+| Debt | Debt |
+| Mortgage | Mortgage |
+
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AccountUpdate.md

@@ -0,0 +1,32 @@
+# AccountUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**iban** | Option<**String**> |  | [optional]
+**bic** | Option<**String**> |  | [optional]
+**account_number** | Option<**String**> |  | [optional]
+**opening_balance** | Option<**String**> |  | [optional]
+**opening_balance_date** | Option<**String**> |  | [optional]
+**virtual_balance** | Option<**String**> |  | [optional]
+**currency_id** | Option<**String**> | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional]
+**currency_code** | Option<**String**> | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional]
+**active** | Option<**bool**> | If omitted, defaults to true. | [optional][default to true]
+**order** | Option<**i32**> | Order of the account | [optional]
+**include_net_worth** | Option<**bool**> | If omitted, defaults to true. | [optional][default to true]
+**account_role** | Option<[**models::AccountRoleProperty**](AccountRoleProperty.md)> |  | [optional]
+**credit_card_type** | Option<[**models::CreditCardTypeProperty**](CreditCardTypeProperty.md)> |  | [optional]
+**monthly_payment_date** | Option<**String**> | Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank. | [optional]
+**liability_type** | Option<[**models::LiabilityTypeProperty**](LiabilityTypeProperty.md)> |  | [optional]
+**interest** | Option<**String**> | Mandatory when type is liability. Interest percentage. | [optional]
+**interest_period** | Option<[**models::InterestPeriodProperty**](InterestPeriodProperty.md)> |  | [optional]
+**notes** | Option<**String**> |  | [optional]
+**latitude** | Option<**f64**> | 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. | [optional]
+**longitude** | Option<**f64**> | 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. | [optional]
+**zoom_level** | Option<**i32**> | 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. | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AccountsApi.md

@@ -0,0 +1,278 @@
+# \AccountsApi
+
+All URIs are relative to *https://demo.firefly-iii.org/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_account**](AccountsApi.md#delete_account) | **DELETE** /v1/accounts/{id} | Permanently delete account.
+[**get_account**](AccountsApi.md#get_account) | **GET** /v1/accounts/{id} | Get single account.
+[**list_account**](AccountsApi.md#list_account) | **GET** /v1/accounts | List all accounts.
+[**list_attachment_by_account**](AccountsApi.md#list_attachment_by_account) | **GET** /v1/accounts/{id}/attachments | Lists all attachments.
+[**list_piggy_bank_by_account**](AccountsApi.md#list_piggy_bank_by_account) | **GET** /v1/accounts/{id}/piggy-banks | List all piggy banks related to the account.
+[**list_transaction_by_account**](AccountsApi.md#list_transaction_by_account) | **GET** /v1/accounts/{id}/transactions | List all transactions related to the account.
+[**store_account**](AccountsApi.md#store_account) | **POST** /v1/accounts | Create new account.
+[**update_account**](AccountsApi.md#update_account) | **PUT** /v1/accounts/{id} | Update existing account.
+
+
+
+## delete_account
+
+> delete_account(id, x_trace_id)
+Permanently delete account.
+
+Will permanently delete an account. Any associated transactions and piggy banks are ALSO deleted. Cannot be recovered from. 
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the account. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+
+### Return type
+
+ (empty response body)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## get_account
+
+> models::AccountSingle get_account(id, x_trace_id, date)
+Get single account.
+
+Returns a single account by its ID. 
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the account. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**date** | Option<**String**> | A date formatted YYYY-MM-DD. When added to the request, Firefly III will show the account's balance on that day.  |  |
+
+### Return type
+
+[**models::AccountSingle**](AccountSingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/vnd.api+json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## list_account
+
+> models::AccountArray list_account(x_trace_id, limit, page, date, r#type)
+List all accounts.
+
+This endpoint returns a list of all the accounts owned by the authenticated user. 
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**limit** | Option<**i32**> | Number of items per page. The default pagination is per 50 items. |  |
+**page** | Option<**i32**> | Page number. The default pagination is per 50 items. |  |
+**date** | Option<**String**> | A date formatted YYYY-MM-DD. When added to the request, Firefly III will show the account's balance on that day.  |  |
+**r#type** | Option<[**AccountTypeFilter**](.md)> | Optional filter on the account type(s) returned |  |
+
+### Return type
+
+[**models::AccountArray**](AccountArray.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/vnd.api+json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## list_attachment_by_account
+
+> models::AttachmentArray list_attachment_by_account(id, x_trace_id, limit, page)
+Lists all attachments.
+
+Lists all attachments.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the account. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**limit** | Option<**i32**> | Number of items per page. The default pagination is per 50 items. |  |
+**page** | Option<**i32**> | Page number. The default pagination is per 50 items. |  |
+
+### Return type
+
+[**models::AttachmentArray**](AttachmentArray.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/vnd.api+json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## list_piggy_bank_by_account
+
+> models::PiggyBankArray list_piggy_bank_by_account(id, x_trace_id, limit, page)
+List all piggy banks related to the account.
+
+This endpoint returns a list of all the piggy banks connected to the account. 
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the account. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**limit** | Option<**i32**> | Number of items per page. The default pagination is per 50 items. |  |
+**page** | Option<**i32**> | Page number. The default pagination is per 50 items. |  |
+
+### Return type
+
+[**models::PiggyBankArray**](PiggyBankArray.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/vnd.api+json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## list_transaction_by_account
+
+> models::TransactionArray list_transaction_by_account(id, x_trace_id, limit, page, start, end, r#type)
+List all transactions related to the account.
+
+This endpoint returns a list of all the transactions connected to the account. 
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the account. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**limit** | Option<**i32**> | Number of items per page. The default pagination is per 50 items. |  |
+**page** | Option<**i32**> | Page number. The default pagination is per 50 items. |  |
+**start** | Option<**String**> | A date formatted YYYY-MM-DD.  |  |
+**end** | Option<**String**> | A date formatted YYYY-MM-DD.  |  |
+**r#type** | Option<[**TransactionTypeFilter**](.md)> | Optional filter on the transaction type(s) returned. |  |
+
+### Return type
+
+[**models::TransactionArray**](TransactionArray.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/vnd.api+json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## store_account
+
+> models::AccountSingle store_account(account_store, x_trace_id)
+Create new account.
+
+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).
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**account_store** | [**AccountStore**](AccountStore.md) | JSON array with the necessary account information or key=value pairs. See the model for the exact specifications. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+
+### Return type
+
+[**models::AccountSingle**](AccountSingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded
+- **Accept**: application/json, application/vnd.api+json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## update_account
+
+> models::AccountSingle update_account(id, account_update, x_trace_id)
+Update existing account.
+
+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. 
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the account. | [required] |
+**account_update** | [**AccountUpdate**](AccountUpdate.md) | JSON array or formdata with updated account information. See the model for the exact specifications. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+
+### Return type
+
+[**models::AccountSingle**](AccountSingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded
+- **Accept**: application/json, application/vnd.api+json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

firefly-iii-api/docs/AttachableType.md

@@ -0,0 +1,17 @@
+# AttachableType
+
+## Enum Variants
+
+| Name | Value |
+|---- | -----|
+| Account | Account |
+| Budget | Budget |
+| Bill | Bill |
+| TransactionJournal | TransactionJournal |
+| PiggyBank | PiggyBank |
+| Tag | Tag |
+
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/Attachment.md

@@ -0,0 +1,22 @@
+# Attachment
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | Option<**String**> |  | [optional][readonly]
+**updated_at** | Option<**String**> |  | [optional][readonly]
+**attachable_type** | [**models::AttachableType**](AttachableType.md) |  | 
+**attachable_id** | **String** | ID of the model this attachment is linked to. | 
+**md5** | Option<**String**> | MD5 hash of the file for basic duplicate detection. | [optional]
+**filename** | **String** |  | 
+**download_url** | Option<**String**> |  | [optional]
+**upload_url** | Option<**String**> |  | [optional]
+**title** | Option<**String**> |  | [optional]
+**notes** | Option<**String**> |  | [optional]
+**mime** | Option<**String**> |  | [optional][readonly]
+**size** | Option<**i32**> |  | [optional][readonly]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AttachmentArray.md

@@ -0,0 +1,12 @@
+# AttachmentArray
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Vec<models::AttachmentRead>**](AttachmentRead.md) |  | 
+**meta** | [**models::Meta**](Meta.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AttachmentRead.md

@@ -0,0 +1,14 @@
+# AttachmentRead
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**r#type** | **String** | Immutable value | 
+**id** | **String** |  | 
+**attributes** | [**models::Attachment**](Attachment.md) |  | 
+**links** | [**models::ObjectLink**](ObjectLink.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AttachmentSingle.md

@@ -0,0 +1,11 @@
+# AttachmentSingle
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**models::AttachmentRead**](AttachmentRead.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AttachmentStore.md

@@ -0,0 +1,15 @@
+# AttachmentStore
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**filename** | **String** |  | 
+**attachable_type** | [**models::AttachableType**](AttachableType.md) |  | 
+**attachable_id** | **String** | ID of the model this attachment is linked to. | 
+**title** | Option<**String**> |  | [optional]
+**notes** | Option<**String**> |  | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AttachmentUpdate.md

@@ -0,0 +1,13 @@
+# AttachmentUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**filename** | Option<**String**> |  | [optional]
+**title** | Option<**String**> |  | [optional]
+**notes** | Option<**String**> |  | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AttachmentsApi.md

@@ -0,0 +1,235 @@
+# \AttachmentsApi
+
+All URIs are relative to *https://demo.firefly-iii.org/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_attachment**](AttachmentsApi.md#delete_attachment) | **DELETE** /v1/attachments/{id} | Delete an attachment.
+[**download_attachment**](AttachmentsApi.md#download_attachment) | **GET** /v1/attachments/{id}/download | Download a single attachment.
+[**get_attachment**](AttachmentsApi.md#get_attachment) | **GET** /v1/attachments/{id} | Get a single attachment.
+[**list_attachment**](AttachmentsApi.md#list_attachment) | **GET** /v1/attachments | List all attachments.
+[**store_attachment**](AttachmentsApi.md#store_attachment) | **POST** /v1/attachments | Store a new attachment.
+[**update_attachment**](AttachmentsApi.md#update_attachment) | **PUT** /v1/attachments/{id} | Update existing attachment.
+[**upload_attachment**](AttachmentsApi.md#upload_attachment) | **POST** /v1/attachments/{id}/upload | Upload an attachment.
+
+
+
+## delete_attachment
+
+> delete_attachment(id, x_trace_id)
+Delete an attachment.
+
+With this endpoint you delete an attachment, including any stored file data. 
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the single attachment. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+
+### Return type
+
+ (empty response body)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## download_attachment
+
+> std::path::PathBuf download_attachment(id, x_trace_id)
+Download a single attachment.
+
+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\". 
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the attachment. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+
+### Return type
+
+[**std::path::PathBuf**](std::path::PathBuf.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/octet-stream, application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## get_attachment
+
+> models::AttachmentSingle get_attachment(id, x_trace_id)
+Get a single attachment.
+
+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). 
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the attachment. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+
+### Return type
+
+[**models::AttachmentSingle**](AttachmentSingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/vnd.api+json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## list_attachment
+
+> models::AttachmentArray list_attachment(x_trace_id, limit, page)
+List all attachments.
+
+This endpoint lists all attachments. 
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**limit** | Option<**i32**> | Number of items per page. The default pagination is per 50 items. |  |
+**page** | Option<**i32**> | Page number. The default pagination is per 50 items. |  |
+
+### Return type
+
+[**models::AttachmentArray**](AttachmentArray.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/vnd.api+json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## store_attachment
+
+> models::AttachmentSingle store_attachment(attachment_store, x_trace_id)
+Store a new attachment.
+
+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. 
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**attachment_store** | [**AttachmentStore**](AttachmentStore.md) | JSON array or key=value pairs with the necessary attachment information. See the model for the exact specifications. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+
+### Return type
+
+[**models::AttachmentSingle**](AttachmentSingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded
+- **Accept**: application/json, application/vnd.api+json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## update_attachment
+
+> models::AttachmentSingle update_attachment(id, attachment_update, x_trace_id)
+Update existing attachment.
+
+Update the meta data for an existing attachment. This endpoint does not allow you to upload or download data. For that, see below. 
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the attachment. | [required] |
+**attachment_update** | [**AttachmentUpdate**](AttachmentUpdate.md) | JSON array with updated attachment information. See the model for the exact specifications. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+
+### Return type
+
+[**models::AttachmentSingle**](AttachmentSingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded
+- **Accept**: application/json, application/vnd.api+json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## upload_attachment
+
+> upload_attachment(id, x_trace_id, body)
+Upload an attachment.
+
+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. 
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the attachment. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**body** | Option<**std::path::PathBuf**> |  |  |
+
+### Return type
+
+ (empty response body)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/octet-stream
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

firefly-iii-api/docs/AutoBudgetPeriod.md

@@ -0,0 +1,18 @@
+# AutoBudgetPeriod
+
+## Enum Variants
+
+| Name | Value |
+|---- | -----|
+| Daily | daily |
+| Weekly | weekly |
+| Monthly | monthly |
+| Quarterly | quarterly |
+| HalfYear | half-year |
+| Yearly | yearly |
+| Null | null |
+
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AutoBudgetType.md

@@ -0,0 +1,15 @@
+# AutoBudgetType
+
+## Enum Variants
+
+| Name | Value |
+|---- | -----|
+| Reset | reset |
+| Rollover | rollover |
+| None | none |
+| Null | null |
+
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AutocompleteAccount.md

@@ -0,0 +1,19 @@
+# AutocompleteAccount
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** | Name of the account found by an auto-complete search. | 
+**name_with_balance** | **String** | Asset accounts and liabilities have a second field with the given date's account balance. | 
+**r#type** | **String** | Account type of the account found by the auto-complete search. | 
+**currency_id** | **String** | ID for the currency used by this account. | 
+**currency_name** | **String** | Currency name for the currency used by this account. | 
+**currency_code** | **String** | Currency code for the currency used by this account. | 
+**currency_symbol** | **String** | Currency symbol for the currency used by this account. | 
+**currency_decimal_places** | **i32** | Number of decimal places for the currency used by this account. | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AutocompleteApi.md

@@ -0,0 +1,506 @@
+# \AutocompleteApi
+
+All URIs are relative to *https://demo.firefly-iii.org/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_accounts_ac**](AutocompleteApi.md#get_accounts_ac) | **GET** /v1/autocomplete/accounts | Returns all accounts of the user returned in a basic auto-complete array.
+[**get_bills_ac**](AutocompleteApi.md#get_bills_ac) | **GET** /v1/autocomplete/bills | Returns all bills of the user returned in a basic auto-complete array.
+[**get_budgets_ac**](AutocompleteApi.md#get_budgets_ac) | **GET** /v1/autocomplete/budgets | Returns all budgets of the user returned in a basic auto-complete array.
+[**get_categories_ac**](AutocompleteApi.md#get_categories_ac) | **GET** /v1/autocomplete/categories | Returns all categories of the user returned in a basic auto-complete array.
+[**get_currencies_ac**](AutocompleteApi.md#get_currencies_ac) | **GET** /v1/autocomplete/currencies | Returns all currencies of the user returned in a basic auto-complete array.
+[**get_currencies_code_ac**](AutocompleteApi.md#get_currencies_code_ac) | **GET** /v1/autocomplete/currencies-with-code | Returns all currencies of the user returned in a basic auto-complete array. This endpoint is DEPRECATED and I suggest you DO NOT use it.
+[**get_object_groups_ac**](AutocompleteApi.md#get_object_groups_ac) | **GET** /v1/autocomplete/object-groups | Returns all object groups of the user returned in a basic auto-complete array.
+[**get_piggies_ac**](AutocompleteApi.md#get_piggies_ac) | **GET** /v1/autocomplete/piggy-banks | Returns all piggy banks of the user returned in a basic auto-complete array.
+[**get_piggies_balance_ac**](AutocompleteApi.md#get_piggies_balance_ac) | **GET** /v1/autocomplete/piggy-banks-with-balance | Returns all piggy banks of the user returned in a basic auto-complete array complemented with balance information.
+[**get_recurring_ac**](AutocompleteApi.md#get_recurring_ac) | **GET** /v1/autocomplete/recurring | Returns all recurring transactions of the user returned in a basic auto-complete array.
+[**get_rule_groups_ac**](AutocompleteApi.md#get_rule_groups_ac) | **GET** /v1/autocomplete/rule-groups | Returns all rule groups of the user returned in a basic auto-complete array.
+[**get_rules_ac**](AutocompleteApi.md#get_rules_ac) | **GET** /v1/autocomplete/rules | Returns all rules of the user returned in a basic auto-complete array.
+[**get_tag_ac**](AutocompleteApi.md#get_tag_ac) | **GET** /v1/autocomplete/tags | Returns all tags of the user returned in a basic auto-complete array.
+[**get_transaction_types_ac**](AutocompleteApi.md#get_transaction_types_ac) | **GET** /v1/autocomplete/transaction-types | Returns all transaction types returned in a basic auto-complete array. English only.
+[**get_transactions_ac**](AutocompleteApi.md#get_transactions_ac) | **GET** /v1/autocomplete/transactions | Returns all transaction descriptions of the user returned in a basic auto-complete array.
+[**get_transactions_idac**](AutocompleteApi.md#get_transactions_idac) | **GET** /v1/autocomplete/transactions-with-id | Returns all transactions, complemented with their ID, of the user returned in a basic auto-complete array. This endpoint is DEPRECATED and I suggest you DO NOT use it.
+
+
+
+## get_accounts_ac
+
+> Vec<models::AutocompleteAccount> get_accounts_ac(x_trace_id, query, limit, date, types)
+Returns all accounts of the user returned in a basic auto-complete array.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**query** | Option<**String**> | The autocomplete search query. |  |
+**limit** | Option<**i32**> | The number of items returned. |  |
+**date** | Option<**String**> | If the account is an asset account or a liability, the autocomplete will also return the balance of the account on this date. |  |
+**types** | Option<[**Vec<models::AccountTypeFilter>**](models::AccountTypeFilter.md)> | Optional filter on the account type(s) used in the autocomplete. |  |
+
+### Return type
+
+[**Vec<models::AutocompleteAccount>**](AutocompleteAccount.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## get_bills_ac
+
+> Vec<models::AutocompleteBill> get_bills_ac(x_trace_id, query, limit)
+Returns all bills of the user returned in a basic auto-complete array.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**query** | Option<**String**> | The autocomplete search query. |  |
+**limit** | Option<**i32**> | The number of items returned. |  |
+
+### Return type
+
+[**Vec<models::AutocompleteBill>**](AutocompleteBill.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## get_budgets_ac
+
+> Vec<models::AutocompleteBudget> get_budgets_ac(x_trace_id, query, limit)
+Returns all budgets of the user returned in a basic auto-complete array.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**query** | Option<**String**> | The autocomplete search query. |  |
+**limit** | Option<**i32**> | The number of items returned. |  |
+
+### Return type
+
+[**Vec<models::AutocompleteBudget>**](AutocompleteBudget.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## get_categories_ac
+
+> Vec<models::AutocompleteCategory> get_categories_ac(x_trace_id, query, limit)
+Returns all categories of the user returned in a basic auto-complete array.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**query** | Option<**String**> | The autocomplete search query. |  |
+**limit** | Option<**i32**> | The number of items returned. |  |
+
+### Return type
+
+[**Vec<models::AutocompleteCategory>**](AutocompleteCategory.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## get_currencies_ac
+
+> Vec<models::AutocompleteCurrency> get_currencies_ac(x_trace_id, query, limit)
+Returns all currencies of the user returned in a basic auto-complete array.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**query** | Option<**String**> | The autocomplete search query. |  |
+**limit** | Option<**i32**> | The number of items returned. |  |
+
+### Return type
+
+[**Vec<models::AutocompleteCurrency>**](AutocompleteCurrency.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## get_currencies_code_ac
+
+> Vec<models::AutocompleteCurrencyCode> get_currencies_code_ac(x_trace_id, query, limit)
+Returns all currencies of the user returned in a basic auto-complete array. This endpoint is DEPRECATED and I suggest you DO NOT use it.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**query** | Option<**String**> | The autocomplete search query. |  |
+**limit** | Option<**i32**> | The number of items returned. |  |
+
+### Return type
+
+[**Vec<models::AutocompleteCurrencyCode>**](AutocompleteCurrencyCode.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## get_object_groups_ac
+
+> Vec<models::AutocompleteObjectGroup> get_object_groups_ac(x_trace_id, query, limit)
+Returns all object groups of the user returned in a basic auto-complete array.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**query** | Option<**String**> | The autocomplete search query. |  |
+**limit** | Option<**i32**> | The number of items returned. |  |
+
+### Return type
+
+[**Vec<models::AutocompleteObjectGroup>**](AutocompleteObjectGroup.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## get_piggies_ac
+
+> Vec<models::AutocompletePiggy> get_piggies_ac(x_trace_id, query, limit)
+Returns all piggy banks of the user returned in a basic auto-complete array.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**query** | Option<**String**> | The autocomplete search query. |  |
+**limit** | Option<**i32**> | The number of items returned. |  |
+
+### Return type
+
+[**Vec<models::AutocompletePiggy>**](AutocompletePiggy.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## get_piggies_balance_ac
+
+> Vec<models::AutocompletePiggyBalance> get_piggies_balance_ac(x_trace_id, query, limit)
+Returns all piggy banks of the user returned in a basic auto-complete array complemented with balance information.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**query** | Option<**String**> | The autocomplete search query. |  |
+**limit** | Option<**i32**> | The number of items returned. |  |
+
+### Return type
+
+[**Vec<models::AutocompletePiggyBalance>**](AutocompletePiggyBalance.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## get_recurring_ac
+
+> Vec<models::AutocompleteRecurrence> get_recurring_ac(x_trace_id, query, limit)
+Returns all recurring transactions of the user returned in a basic auto-complete array.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**query** | Option<**String**> | The autocomplete search query. |  |
+**limit** | Option<**i32**> | The number of items returned. |  |
+
+### Return type
+
+[**Vec<models::AutocompleteRecurrence>**](AutocompleteRecurrence.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## get_rule_groups_ac
+
+> Vec<models::AutocompleteRuleGroup> get_rule_groups_ac(x_trace_id, query, limit)
+Returns all rule groups of the user returned in a basic auto-complete array.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**query** | Option<**String**> | The autocomplete search query. |  |
+**limit** | Option<**i32**> | The number of items returned. |  |
+
+### Return type
+
+[**Vec<models::AutocompleteRuleGroup>**](AutocompleteRuleGroup.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## get_rules_ac
+
+> Vec<models::AutocompleteRule> get_rules_ac(x_trace_id, query, limit)
+Returns all rules of the user returned in a basic auto-complete array.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**query** | Option<**String**> | The autocomplete search query. |  |
+**limit** | Option<**i32**> | The number of items returned. |  |
+
+### Return type
+
+[**Vec<models::AutocompleteRule>**](AutocompleteRule.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## get_tag_ac
+
+> Vec<models::AutocompleteTag> get_tag_ac(x_trace_id, query, limit)
+Returns all tags of the user returned in a basic auto-complete array.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**query** | Option<**String**> | The autocomplete search query. |  |
+**limit** | Option<**i32**> | The number of items returned. |  |
+
+### Return type
+
+[**Vec<models::AutocompleteTag>**](AutocompleteTag.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## get_transaction_types_ac
+
+> Vec<models::AutocompleteTransactionType> get_transaction_types_ac(x_trace_id, query, limit)
+Returns all transaction types returned in a basic auto-complete array. English only.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**query** | Option<**String**> | The autocomplete search query. |  |
+**limit** | Option<**i32**> | The number of items returned. |  |
+
+### Return type
+
+[**Vec<models::AutocompleteTransactionType>**](AutocompleteTransactionType.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## get_transactions_ac
+
+> Vec<models::AutocompleteTransaction> get_transactions_ac(x_trace_id, query, limit)
+Returns all transaction descriptions of the user returned in a basic auto-complete array.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**query** | Option<**String**> | The autocomplete search query. |  |
+**limit** | Option<**i32**> | The number of items returned. |  |
+
+### Return type
+
+[**Vec<models::AutocompleteTransaction>**](AutocompleteTransaction.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## get_transactions_idac
+
+> Vec<models::AutocompleteTransactionId> get_transactions_idac(x_trace_id, query, limit)
+Returns all transactions, complemented with their ID, of the user returned in a basic auto-complete array. This endpoint is DEPRECATED and I suggest you DO NOT use it.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**query** | Option<**String**> | The autocomplete search query. |  |
+**limit** | Option<**i32**> | The number of items returned. |  |
+
+### Return type
+
+[**Vec<models::AutocompleteTransactionId>**](AutocompleteTransactionID.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

firefly-iii-api/docs/AutocompleteBill.md

@@ -0,0 +1,13 @@
+# AutocompleteBill
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** | Name of the bill found by an auto-complete search. | 
+**active** | Option<**bool**> | Is the bill active or not? | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AutocompleteBudget.md

@@ -0,0 +1,12 @@
+# AutocompleteBudget
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** | Name of the budget found by an auto-complete search. | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AutocompleteCategory.md

@@ -0,0 +1,12 @@
+# AutocompleteCategory
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** | Name of the category found by an auto-complete search. | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AutocompleteCurrency.md

@@ -0,0 +1,15 @@
+# AutocompleteCurrency
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** | Currency name. | 
+**code** | **String** | Currency code. | 
+**symbol** | **String** |  | 
+**decimal_places** | **i32** |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AutocompleteCurrencyCode.md

@@ -0,0 +1,15 @@
+# AutocompleteCurrencyCode
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** | Currency name with the code between brackets. | 
+**code** | **String** | Currency code. | 
+**symbol** | **String** |  | 
+**decimal_places** | **i32** |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AutocompleteObjectGroup.md

@@ -0,0 +1,13 @@
+# AutocompleteObjectGroup
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**title** | **String** | Title of the object group found by an auto-complete search. | 
+**name** | **String** | Title of the object group found by an auto-complete search. | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AutocompletePiggy.md

@@ -0,0 +1,19 @@
+# AutocompletePiggy
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** | Name of the piggy bank found by an auto-complete search. | 
+**currency_id** | Option<**String**> | Currency ID for this piggy bank. | [optional]
+**currency_code** | Option<**String**> | Currency code for this piggy bank. | [optional]
+**currency_symbol** | Option<**String**> |  | [optional]
+**currency_name** | Option<**String**> | Currency name for the currency used by this account. | [optional]
+**currency_decimal_places** | Option<**i32**> |  | [optional]
+**object_group_id** | Option<**String**> | The group ID of the group this object is part of. NULL if no group. | [optional]
+**object_group_title** | Option<**String**> | The name of the group. NULL if no group. | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AutocompletePiggyBalance.md

@@ -0,0 +1,19 @@
+# AutocompletePiggyBalance
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** | Name of the piggy bank found by an auto-complete search. | 
+**name_with_balance** | Option<**String**> | Name of the piggy bank found by an auto-complete search with the current balance formatted nicely. | [optional]
+**currency_id** | Option<**String**> | Currency ID for this piggy bank. | [optional]
+**currency_code** | Option<**String**> | Currency code for this piggy bank. | [optional]
+**currency_symbol** | Option<**String**> |  | [optional]
+**currency_decimal_places** | Option<**i32**> |  | [optional]
+**object_group_id** | Option<**String**> | The group ID of the group this object is part of. NULL if no group. | [optional]
+**object_group_title** | Option<**String**> | The name of the group. NULL if no group. | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AutocompleteRecurrence.md

@@ -0,0 +1,13 @@
+# AutocompleteRecurrence
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** | Name of the recurrence found by an auto-complete search. | 
+**description** | Option<**String**> | Description of the recurrence found by auto-complete. | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AutocompleteRule.md

@@ -0,0 +1,13 @@
+# AutocompleteRule
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** | Name of the rule found by an auto-complete search. | 
+**description** | Option<**String**> | Description of the rule found by auto-complete. | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AutocompleteRuleGroup.md

@@ -0,0 +1,13 @@
+# AutocompleteRuleGroup
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** | Name of the rule group found by an auto-complete search. | 
+**description** | Option<**String**> | Description of the rule group found by auto-complete. | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AutocompleteTag.md

@@ -0,0 +1,13 @@
+# AutocompleteTag
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** | Name of the tag found by an auto-complete search. | 
+**tag** | **String** | Name of the tag found by an auto-complete search. | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AutocompleteTransaction.md

@@ -0,0 +1,14 @@
+# AutocompleteTransaction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The ID of a transaction journal (basically a single split). | 
+**transaction_group_id** | Option<**String**> | The ID of the underlying transaction group. | [optional]
+**name** | **String** | Transaction description | 
+**description** | **String** | Transaction description | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AutocompleteTransactionId.md

@@ -0,0 +1,14 @@
+# AutocompleteTransactionId
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The ID of a transaction journal (basically a single split). | 
+**transaction_group_id** | Option<**String**> | The ID of the underlying transaction group. | [optional]
+**name** | **String** | Transaction description with ID in the name. | 
+**description** | **String** | Transaction description with ID in the name. | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AutocompleteTransactionType.md

@@ -0,0 +1,13 @@
+# AutocompleteTransactionType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** | Type of the object found by an auto-complete search. | 
+**r#type** | **String** | Name of the object found by an auto-complete search. | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AvailableBudget.md

@@ -0,0 +1,21 @@
+# AvailableBudget
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | Option<**String**> |  | [optional][readonly]
+**updated_at** | Option<**String**> |  | [optional][readonly]
+**currency_id** | Option<**String**> | Use either currency_id or currency_code. | [optional]
+**currency_code** | Option<**String**> | Use either currency_id or currency_code. | [optional]
+**currency_symbol** | Option<**String**> |  | [optional][readonly]
+**currency_decimal_places** | Option<**i32**> |  | [optional][readonly]
+**amount** | **String** |  | 
+**start** | **String** | Start date of the available budget. | 
+**end** | **String** | End date of the available budget. | 
+**spent_in_budgets** | Option<[**Vec<models::BudgetSpent>**](BudgetSpent.md)> |  | [optional][readonly]
+**spent_outside_budget** | Option<[**Vec<models::BudgetSpent>**](BudgetSpent.md)> |  | [optional][readonly]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AvailableBudgetArray.md

@@ -0,0 +1,12 @@
+# AvailableBudgetArray
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Vec<models::AvailableBudgetRead>**](AvailableBudgetRead.md) |  | 
+**meta** | [**models::Meta**](Meta.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AvailableBudgetRead.md

@@ -0,0 +1,13 @@
+# AvailableBudgetRead
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**r#type** | **String** | Immutable value | 
+**id** | **String** |  | 
+**attributes** | [**models::AvailableBudget**](AvailableBudget.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AvailableBudgetSingle.md

@@ -0,0 +1,11 @@
+# AvailableBudgetSingle
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**models::AvailableBudgetRead**](AvailableBudgetRead.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/AvailableBudgetsApi.md

@@ -0,0 +1,75 @@
+# \AvailableBudgetsApi
+
+All URIs are relative to *https://demo.firefly-iii.org/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_available_budget**](AvailableBudgetsApi.md#get_available_budget) | **GET** /v1/available-budgets/{id} | Get a single available budget.
+[**list_available_budget**](AvailableBudgetsApi.md#list_available_budget) | **GET** /v1/available-budgets | List all available budget amounts.
+
+
+
+## get_available_budget
+
+> models::AvailableBudgetSingle get_available_budget(id, x_trace_id)
+Get a single available budget.
+
+Get a single available budget, by ID.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the available budget. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+
+### Return type
+
+[**models::AvailableBudgetSingle**](AvailableBudgetSingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/vnd.api+json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## list_available_budget
+
+> models::AvailableBudgetArray list_available_budget(x_trace_id, limit, page, start, end)
+List all available budget amounts.
+
+Firefly III allows users to set the amount that is available to be budgeted in so-called \"available budgets\". For example, the user could have 1200,- available to be divided during the coming month. This amount is used on the /budgets page. This endpoint returns all of these amounts and the periods for which they are set. 
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**limit** | Option<**i32**> | Number of items per page. The default pagination is per 50 items. |  |
+**page** | Option<**i32**> | Page number. The default pagination is per 50 items. |  |
+**start** | Option<**String**> | A date formatted YYYY-MM-DD.  |  |
+**end** | Option<**String**> | A date formatted YYYY-MM-DD.  |  |
+
+### Return type
+
+[**models::AvailableBudgetArray**](AvailableBudgetArray.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/vnd.api+json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

firefly-iii-api/docs/BadRequestResponse.md

@@ -0,0 +1,12 @@
+# BadRequestResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | Option<**String**> |  | [optional]
+**exception** | Option<**String**> |  | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/BasicSummaryEntry.md

@@ -0,0 +1,20 @@
+# BasicSummaryEntry
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | Option<**String**> | 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. | [optional]
+**title** | Option<**String**> | A translated title for the information shared. | [optional]
+**monetary_value** | Option<**f64**> | The amount as a float. | [optional]
+**currency_id** | Option<**String**> | The currency ID of the associated currency. | [optional]
+**currency_code** | Option<**String**> |  | [optional]
+**currency_symbol** | Option<**String**> |  | [optional]
+**currency_decimal_places** | Option<**i32**> | Number of decimals for the associated currency. | [optional]
+**value_parsed** | Option<**String**> | The amount formatted according to the users locale | [optional]
+**local_icon** | Option<**String**> | Reference to a font-awesome icon without the fa- part. | [optional]
+**sub_title** | Option<**String**> | A short explanation of the amounts origin. Already formatted according to the locale of the user or translated, if relevant. | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/Bill.md

@@ -0,0 +1,34 @@
+# Bill
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | Option<**String**> |  | [optional][readonly]
+**updated_at** | Option<**String**> |  | [optional][readonly]
+**currency_id** | Option<**String**> | Use either currency_id or currency_code | [optional]
+**currency_code** | Option<**String**> | Use either currency_id or currency_code | [optional]
+**currency_symbol** | Option<**String**> |  | [optional][readonly]
+**currency_decimal_places** | Option<**i32**> |  | [optional][readonly]
+**name** | **String** |  | 
+**amount_min** | **String** |  | 
+**amount_max** | **String** |  | 
+**date** | **String** |  | 
+**end_date** | Option<**String**> | The date after which this bill is no longer valid or applicable | [optional]
+**extension_date** | Option<**String**> | The date before which the bill must be renewed (or cancelled) | [optional]
+**repeat_freq** | [**models::BillRepeatFrequency**](BillRepeatFrequency.md) |  | 
+**skip** | Option<**i32**> | How often the bill must be skipped. 1 means a bi-monthly bill. | [optional]
+**active** | Option<**bool**> | If the bill is active. | [optional]
+**order** | Option<**i32**> | Order of the bill. | [optional]
+**notes** | Option<**String**> |  | [optional]
+**next_expected_match** | Option<**String**> | When the bill is expected to be due. | [optional][readonly]
+**next_expected_match_diff** | Option<**String**> | Formatted (locally) when the bill is due. | [optional][readonly]
+**object_group_id** | Option<**String**> | The group ID of the group this object is part of. NULL if no group. | [optional]
+**object_group_order** | Option<**i32**> | The order of the group. At least 1, for the highest sorting. | [optional][readonly]
+**object_group_title** | Option<**String**> | The name of the group. NULL if no group. | [optional]
+**pay_dates** | Option<**Vec<String>**> | Array of future dates when the bill is expected to be paid. Autogenerated. | [optional][readonly]
+**paid_dates** | Option<[**Vec<models::BillPaidDatesInner>**](Bill_paid_dates_inner.md)> | Array of past transactions when the bill was paid. | [optional][readonly]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/BillArray.md

@@ -0,0 +1,12 @@
+# BillArray
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Vec<models::BillRead>**](BillRead.md) |  | 
+**meta** | [**models::Meta**](Meta.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/BillPaidDatesInner.md

@@ -0,0 +1,13 @@
+# BillPaidDatesInner
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction_group_id** | Option<**String**> | Transaction group ID of the paid bill. | [optional][readonly]
+**transaction_journal_id** | Option<**String**> | Transaction journal ID of the paid bill. | [optional][readonly]
+**date** | Option<**String**> | Date the bill was paid. | [optional][readonly]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/BillRead.md

@@ -0,0 +1,13 @@
+# BillRead
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**r#type** | **String** | Immutable value | 
+**id** | **String** |  | 
+**attributes** | [**models::Bill**](Bill.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/BillRepeatFrequency.md

@@ -0,0 +1,16 @@
+# BillRepeatFrequency
+
+## Enum Variants
+
+| Name | Value |
+|---- | -----|
+| Weekly | weekly |
+| Monthly | monthly |
+| Quarterly | quarterly |
+| HalfYear | half-year |
+| Yearly | yearly |
+
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/BillSingle.md

@@ -0,0 +1,11 @@
+# BillSingle
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**models::BillRead**](BillRead.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/BillStore.md

@@ -0,0 +1,24 @@
+# BillStore
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currency_id** | Option<**String**> | Use either currency_id or currency_code | [optional]
+**currency_code** | Option<**String**> | Use either currency_id or currency_code | [optional]
+**name** | **String** |  | 
+**amount_min** | **String** |  | 
+**amount_max** | **String** |  | 
+**date** | **String** |  | 
+**end_date** | Option<**String**> | The date after which this bill is no longer valid or applicable | [optional]
+**extension_date** | Option<**String**> | The date before which the bill must be renewed (or cancelled) | [optional]
+**repeat_freq** | [**models::BillRepeatFrequency**](BillRepeatFrequency.md) |  | 
+**skip** | Option<**i32**> | How often the bill must be skipped. 1 means a bi-monthly bill. | [optional]
+**active** | Option<**bool**> | If the bill is active. | [optional]
+**notes** | Option<**String**> |  | [optional]
+**object_group_id** | Option<**String**> | The group ID of the group this object is part of. NULL if no group. | [optional]
+**object_group_title** | Option<**String**> | The name of the group. NULL if no group. | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/BillUpdate.md

@@ -0,0 +1,24 @@
+# BillUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currency_id** | Option<**String**> | Use either currency_id or currency_code | [optional]
+**currency_code** | Option<**String**> | Use either currency_id or currency_code | [optional]
+**name** | **String** |  | 
+**amount_min** | Option<**String**> |  | [optional]
+**amount_max** | Option<**String**> |  | [optional]
+**date** | Option<**String**> |  | [optional]
+**end_date** | Option<**String**> | The date after which this bill is no longer valid or applicable | [optional]
+**extension_date** | Option<**String**> | The date before which the bill must be renewed (or cancelled) | [optional]
+**repeat_freq** | Option<[**models::BillRepeatFrequency**](BillRepeatFrequency.md)> |  | [optional]
+**skip** | Option<**i32**> | How often the bill must be skipped. 1 means a bi-monthly bill. | [optional]
+**active** | Option<**bool**> | If the bill is active. | [optional]
+**notes** | Option<**String**> |  | [optional]
+**object_group_id** | Option<**String**> | The group ID of the group this object is part of. NULL if no group. | [optional]
+**object_group_title** | Option<**String**> | The name of the group. NULL if no group. | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/BillsApi.md

@@ -0,0 +1,277 @@
+# \BillsApi
+
+All URIs are relative to *https://demo.firefly-iii.org/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_bill**](BillsApi.md#delete_bill) | **DELETE** /v1/bills/{id} | Delete a bill.
+[**get_bill**](BillsApi.md#get_bill) | **GET** /v1/bills/{id} | Get a single bill.
+[**list_attachment_by_bill**](BillsApi.md#list_attachment_by_bill) | **GET** /v1/bills/{id}/attachments | List all attachments uploaded to the bill.
+[**list_bill**](BillsApi.md#list_bill) | **GET** /v1/bills | List all bills.
+[**list_rule_by_bill**](BillsApi.md#list_rule_by_bill) | **GET** /v1/bills/{id}/rules | List all rules associated with the bill.
+[**list_transaction_by_bill**](BillsApi.md#list_transaction_by_bill) | **GET** /v1/bills/{id}/transactions | List all transactions associated with the  bill.
+[**store_bill**](BillsApi.md#store_bill) | **POST** /v1/bills | Store a new bill
+[**update_bill**](BillsApi.md#update_bill) | **PUT** /v1/bills/{id} | Update existing bill.
+
+
+
+## delete_bill
+
+> delete_bill(id, x_trace_id)
+Delete a bill.
+
+Delete a bill. This will not delete any associated rules. Will not remove associated transactions. WILL remove all associated attachments.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the bill. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+
+### Return type
+
+ (empty response body)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## get_bill
+
+> models::BillSingle get_bill(id, x_trace_id, start, end)
+Get a single bill.
+
+Get a single bill.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the bill. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**start** | Option<**String**> | A date formatted YYYY-MM-DD. If it is are added to the request, Firefly III will calculate the appropriate payment and paid dates.  |  |
+**end** | Option<**String**> | A date formatted YYYY-MM-DD. If it is added to the request, Firefly III will calculate the appropriate payment and paid dates.  |  |
+
+### Return type
+
+[**models::BillSingle**](BillSingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/vnd.api+json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## list_attachment_by_bill
+
+> models::AttachmentArray list_attachment_by_bill(id, x_trace_id, limit, page)
+List all attachments uploaded to the bill.
+
+This endpoint will list all attachments linked to the bill.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the bill. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**limit** | Option<**i32**> | Number of items per page. The default pagination is per 50 items. |  |
+**page** | Option<**i32**> | Page number. The default pagination is per 50 items. |  |
+
+### Return type
+
+[**models::AttachmentArray**](AttachmentArray.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/vnd.api+json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## list_bill
+
+> models::BillArray list_bill(x_trace_id, limit, page, start, end)
+List all bills.
+
+This endpoint will list all the user's bills.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**limit** | Option<**i32**> | Number of items per page. The default pagination is per 50 items. |  |
+**page** | Option<**i32**> | Page number. The default pagination is per 50 items. |  |
+**start** | Option<**String**> | A date formatted YYYY-MM-DD. If it is are added to the request, Firefly III will calculate the appropriate payment and paid dates.  |  |
+**end** | Option<**String**> | A date formatted YYYY-MM-DD. If it is added to the request, Firefly III will calculate the appropriate payment and paid dates.  |  |
+
+### Return type
+
+[**models::BillArray**](BillArray.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/vnd.api+json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## list_rule_by_bill
+
+> models::RuleArray list_rule_by_bill(id, x_trace_id)
+List all rules associated with the bill.
+
+This endpoint will list all rules that have an action to set the bill to this bill.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the bill. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+
+### Return type
+
+[**models::RuleArray**](RuleArray.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/vnd.api+json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## list_transaction_by_bill
+
+> models::TransactionArray list_transaction_by_bill(id, x_trace_id, limit, page, start, end, r#type)
+List all transactions associated with the  bill.
+
+This endpoint will list all transactions linked to this bill.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the bill. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**limit** | Option<**i32**> | Number of items per page. The default pagination is per 50 items. |  |
+**page** | Option<**i32**> | Page number. The default pagination is per 50 items. |  |
+**start** | Option<**String**> | A date formatted YYYY-MM-DD.  |  |
+**end** | Option<**String**> | A date formatted YYYY-MM-DD.  |  |
+**r#type** | Option<[**TransactionTypeFilter**](.md)> | Optional filter on the transaction type(s) returned |  |
+
+### Return type
+
+[**models::TransactionArray**](TransactionArray.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/vnd.api+json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## store_bill
+
+> models::BillSingle store_bill(bill_store, x_trace_id)
+Store a new bill
+
+Creates a new bill. The data required can be submitted as a JSON body or as a list of parameters.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**bill_store** | [**BillStore**](BillStore.md) | JSON array or key=value pairs with the necessary bill information. See the model for the exact specifications. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+
+### Return type
+
+[**models::BillSingle**](BillSingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded
+- **Accept**: application/json, application/vnd.api+json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## update_bill
+
+> models::BillSingle update_bill(id, bill_update, x_trace_id)
+Update existing bill.
+
+Update existing bill.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the bill. | [required] |
+**bill_update** | [**BillUpdate**](BillUpdate.md) | JSON array or key=value pairs with updated bill information. See the model for the exact specifications. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+
+### Return type
+
+[**models::BillSingle**](BillSingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded
+- **Accept**: application/json, application/vnd.api+json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

firefly-iii-api/docs/Budget.md

@@ -0,0 +1,22 @@
+# Budget
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | Option<**String**> |  | [optional][readonly]
+**updated_at** | Option<**String**> |  | [optional][readonly]
+**name** | **String** |  | 
+**active** | Option<**bool**> |  | [optional]
+**notes** | Option<**String**> |  | [optional]
+**order** | Option<**i32**> |  | [optional][readonly]
+**auto_budget_type** | Option<[**models::AutoBudgetType**](AutoBudgetType.md)> |  | [optional]
+**auto_budget_currency_id** | Option<**String**> | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional]
+**auto_budget_currency_code** | Option<**String**> | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional]
+**auto_budget_amount** | Option<**String**> |  | [optional]
+**auto_budget_period** | Option<[**models::AutoBudgetPeriod**](AutoBudgetPeriod.md)> |  | [optional]
+**spent** | Option<[**Vec<models::BudgetSpent>**](BudgetSpent.md)> | Information on how much was spent in this budget. Is only filled in when the start and end date are submitted. | [optional][readonly]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/BudgetArray.md

@@ -0,0 +1,12 @@
+# BudgetArray
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Vec<models::BudgetRead>**](BudgetRead.md) |  | 
+**meta** | [**models::Meta**](Meta.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/BudgetLimit.md

@@ -0,0 +1,23 @@
+# BudgetLimit
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | Option<**String**> |  | [optional][readonly]
+**updated_at** | Option<**String**> |  | [optional][readonly]
+**start** | **String** | Start date of the budget limit. | 
+**end** | **String** | End date of the budget limit. | 
+**currency_id** | Option<**String**> | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional]
+**currency_code** | Option<**String**> | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional]
+**currency_name** | Option<**String**> |  | [optional][readonly]
+**currency_symbol** | Option<**String**> |  | [optional][readonly]
+**currency_decimal_places** | Option<**i32**> |  | [optional][readonly]
+**budget_id** | **String** | The budget ID of the associated budget. | [readonly]
+**period** | Option<**String**> | Period of the budget limit. Only used when auto-generated by auto-budget. | [optional][readonly]
+**amount** | **String** |  | 
+**spent** | Option<**String**> |  | [optional][readonly]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/BudgetLimitArray.md

@@ -0,0 +1,12 @@
+# BudgetLimitArray
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Vec<models::BudgetLimitRead>**](BudgetLimitRead.md) |  | 
+**meta** | [**models::Meta**](Meta.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/BudgetLimitRead.md

@@ -0,0 +1,13 @@
+# BudgetLimitRead
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**r#type** | **String** | Immutable value | 
+**id** | **String** |  | 
+**attributes** | [**models::BudgetLimit**](BudgetLimit.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/BudgetLimitSingle.md

@@ -0,0 +1,11 @@
+# BudgetLimitSingle
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**models::BudgetLimitRead**](BudgetLimitRead.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/BudgetLimitStore.md

@@ -0,0 +1,17 @@
+# BudgetLimitStore
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currency_id** | Option<**String**> | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional]
+**currency_code** | Option<**String**> | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional]
+**budget_id** | **String** | The budget ID of the associated budget. | [readonly]
+**start** | [**String**](string.md) | Start date of the budget limit. | 
+**period** | Option<**String**> | Period of the budget limit. Only used when auto-generated by auto-budget. | [optional][readonly]
+**end** | [**String**](string.md) | End date of the budget limit. | 
+**amount** | **String** |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/BudgetRead.md

@@ -0,0 +1,13 @@
+# BudgetRead
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**r#type** | **String** | Immutable value | 
+**id** | **String** |  | 
+**attributes** | [**models::Budget**](Budget.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/BudgetSingle.md

@@ -0,0 +1,11 @@
+# BudgetSingle
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**models::BudgetRead**](BudgetRead.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/BudgetSpent.md

@@ -0,0 +1,15 @@
+# BudgetSpent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sum** | Option<**String**> | The amount spent. | [optional]
+**currency_id** | Option<**String**> |  | [optional]
+**currency_code** | Option<**String**> |  | [optional]
+**currency_symbol** | Option<**String**> |  | [optional]
+**currency_decimal_places** | Option<**i32**> | Number of decimals supported by the currency | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/BudgetStore.md

@@ -0,0 +1,19 @@
+# BudgetStore
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**active** | Option<**bool**> |  | [optional]
+**order** | Option<**i32**> |  | [optional][readonly]
+**notes** | Option<**String**> |  | [optional]
+**auto_budget_type** | Option<[**models::AutoBudgetType**](AutoBudgetType.md)> |  | [optional]
+**auto_budget_currency_id** | Option<**String**> | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional]
+**auto_budget_currency_code** | Option<**String**> | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional]
+**auto_budget_amount** | Option<**String**> |  | [optional]
+**auto_budget_period** | Option<[**models::AutoBudgetPeriod**](AutoBudgetPeriod.md)> |  | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/BudgetUpdate.md

@@ -0,0 +1,19 @@
+# BudgetUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**active** | Option<**bool**> |  | [optional]
+**order** | Option<**i32**> |  | [optional]
+**notes** | Option<**String**> |  | [optional]
+**auto_budget_type** | Option<[**models::AutoBudgetType**](AutoBudgetType.md)> |  | [optional]
+**auto_budget_currency_id** | Option<**String**> | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional]
+**auto_budget_currency_code** | Option<**String**> | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional]
+**auto_budget_amount** | Option<**String**> |  | [optional]
+**auto_budget_period** | Option<[**models::AutoBudgetPeriod**](AutoBudgetPeriod.md)> |  | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/BudgetsApi.md

@@ -0,0 +1,479 @@
+# \BudgetsApi
+
+All URIs are relative to *https://demo.firefly-iii.org/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_budget**](BudgetsApi.md#delete_budget) | **DELETE** /v1/budgets/{id} | Delete a budget.
+[**delete_budget_limit**](BudgetsApi.md#delete_budget_limit) | **DELETE** /v1/budgets/{id}/limits/{limitId} | Delete a budget limit.
+[**get_budget**](BudgetsApi.md#get_budget) | **GET** /v1/budgets/{id} | Get a single budget.
+[**get_budget_limit**](BudgetsApi.md#get_budget_limit) | **GET** /v1/budgets/{id}/limits/{limitId} | Get single budget limit.
+[**list_attachment_by_budget**](BudgetsApi.md#list_attachment_by_budget) | **GET** /v1/budgets/{id}/attachments | Lists all attachments of a budget.
+[**list_budget**](BudgetsApi.md#list_budget) | **GET** /v1/budgets | List all budgets.
+[**list_budget_limit**](BudgetsApi.md#list_budget_limit) | **GET** /v1/budget-limits | Get list of budget limits by date
+[**list_budget_limit_by_budget**](BudgetsApi.md#list_budget_limit_by_budget) | **GET** /v1/budgets/{id}/limits | Get all limits for a budget.
+[**list_transaction_by_budget**](BudgetsApi.md#list_transaction_by_budget) | **GET** /v1/budgets/{id}/transactions | All transactions to a budget.
+[**list_transaction_by_budget_limit**](BudgetsApi.md#list_transaction_by_budget_limit) | **GET** /v1/budgets/{id}/limits/{limitId}/transactions | List all transactions by a budget limit ID.
+[**store_budget**](BudgetsApi.md#store_budget) | **POST** /v1/budgets | Store a new budget
+[**store_budget_limit**](BudgetsApi.md#store_budget_limit) | **POST** /v1/budgets/{id}/limits | Store new budget limit.
+[**update_budget**](BudgetsApi.md#update_budget) | **PUT** /v1/budgets/{id} | Update existing budget.
+[**update_budget_limit**](BudgetsApi.md#update_budget_limit) | **PUT** /v1/budgets/{id}/limits/{limitId} | Update existing budget limit.
+
+
+
+## delete_budget
+
+> delete_budget(id, x_trace_id)
+Delete a budget.
+
+Delete a budget. Transactions will not be deleted.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the budget. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+
+### Return type
+
+ (empty response body)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## delete_budget_limit
+
+> delete_budget_limit(id, limit_id, x_trace_id)
+Delete a budget limit.
+
+Delete a budget limit.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the budget. The budget limit MUST be associated to the budget ID. | [required] |
+**limit_id** | **String** | The ID of the budget limit. The budget limit MUST be associated to the budget ID. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+
+### Return type
+
+ (empty response body)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## get_budget
+
+> models::BudgetSingle get_budget(id, x_trace_id, start, end)
+Get a single budget.
+
+Get a single budget. If the start date and end date are submitted as well, the \"spent\" array will be updated accordingly.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the requested budget. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**start** | Option<**String**> | A date formatted YYYY-MM-DD, to get info on how much the user has spent.  |  |
+**end** | Option<**String**> | A date formatted YYYY-MM-DD, to get info on how much the user has spent.  |  |
+
+### Return type
+
+[**models::BudgetSingle**](BudgetSingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.api+json, application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## get_budget_limit
+
+> models::BudgetLimitSingle get_budget_limit(id, limit_id, x_trace_id)
+Get single budget limit.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the budget. The budget limit MUST be associated to the budget ID. | [required] |
+**limit_id** | **i32** | The ID of the budget limit. The budget limit MUST be associated to the budget ID. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+
+### Return type
+
+[**models::BudgetLimitSingle**](BudgetLimitSingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.api+json, application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## list_attachment_by_budget
+
+> models::AttachmentArray list_attachment_by_budget(id, x_trace_id, limit, page)
+Lists all attachments of a budget.
+
+Lists all attachments.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the budget. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**limit** | Option<**i32**> | Number of items per page. The default pagination is per 50 items. |  |
+**page** | Option<**i32**> | Page number. The default pagination is per 50 items. |  |
+
+### Return type
+
+[**models::AttachmentArray**](AttachmentArray.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.api+json, application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## list_budget
+
+> models::BudgetArray list_budget(x_trace_id, limit, page, start, end)
+List all budgets.
+
+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.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**limit** | Option<**i32**> | Number of items per page. The default pagination is per 50 items. |  |
+**page** | Option<**i32**> | Page number. The default pagination is per 50 items. |  |
+**start** | Option<**String**> | A date formatted YYYY-MM-DD, to get info on how much the user has spent. You must submit both start and end.  |  |
+**end** | Option<**String**> | A date formatted YYYY-MM-DD, to get info on how much the user has spent. You must submit both start and end.  |  |
+
+### Return type
+
+[**models::BudgetArray**](BudgetArray.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.api+json, application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## list_budget_limit
+
+> models::BudgetLimitArray list_budget_limit(start, end, x_trace_id)
+Get list of budget limits by date
+
+Get all budget limits for for this date range. 
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**start** | **String** | A date formatted YYYY-MM-DD.  | [required] |
+**end** | **String** | A date formatted YYYY-MM-DD.  | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+
+### Return type
+
+[**models::BudgetLimitArray**](BudgetLimitArray.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.api+json, application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## list_budget_limit_by_budget
+
+> models::BudgetLimitArray list_budget_limit_by_budget(id, x_trace_id, start, end)
+Get all limits for a budget.
+
+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. 
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the requested budget. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**start** | Option<**String**> | A date formatted YYYY-MM-DD.  |  |
+**end** | Option<**String**> | A date formatted YYYY-MM-DD.  |  |
+
+### Return type
+
+[**models::BudgetLimitArray**](BudgetLimitArray.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.api+json, application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## list_transaction_by_budget
+
+> models::TransactionArray list_transaction_by_budget(id, x_trace_id, limit, page, start, end, r#type)
+All transactions to a budget.
+
+Get all transactions linked to a budget, possibly limited by start and end
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the budget. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**limit** | Option<**i32**> | Number of items per page. The default pagination is per 50 items. |  |
+**page** | Option<**i32**> | Page number. The default pagination is per 50 items. |  |
+**start** | Option<**String**> | A date formatted YYYY-MM-DD.  |  |
+**end** | Option<**String**> | A date formatted YYYY-MM-DD.  |  |
+**r#type** | Option<[**TransactionTypeFilter**](.md)> | Optional filter on the transaction type(s) returned |  |
+
+### Return type
+
+[**models::TransactionArray**](TransactionArray.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.api+json, application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## list_transaction_by_budget_limit
+
+> models::TransactionArray list_transaction_by_budget_limit(id, limit_id, x_trace_id, limit, page, r#type)
+List all transactions by a budget limit ID.
+
+List all the transactions within one budget limit. The start and end date are dictated by the budget limit.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the budget. The budget limit MUST be associated to the budget ID. | [required] |
+**limit_id** | **String** | The ID of the budget limit. The budget limit MUST be associated to the budget ID. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**limit** | Option<**i32**> | Number of items per page. The default pagination is per 50 items. |  |
+**page** | Option<**i32**> | Page number. The default pagination is per 50 items. |  |
+**r#type** | Option<[**TransactionTypeFilter**](.md)> | Optional filter on the transaction type(s) returned |  |
+
+### Return type
+
+[**models::TransactionArray**](TransactionArray.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.api+json, application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## store_budget
+
+> models::BudgetSingle store_budget(budget_store, x_trace_id)
+Store a new budget
+
+Creates a new budget. The data required can be submitted as a JSON body or as a list of parameters.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**budget_store** | [**BudgetStore**](BudgetStore.md) | JSON array or key=value pairs with the necessary budget information. See the model for the exact specifications. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+
+### Return type
+
+[**models::BudgetSingle**](BudgetSingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded
+- **Accept**: application/vnd.api+json, application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## store_budget_limit
+
+> models::BudgetLimitSingle store_budget_limit(id, budget_limit_store, x_trace_id)
+Store new budget limit.
+
+Store a new budget limit under this budget.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the budget. | [required] |
+**budget_limit_store** | [**BudgetLimitStore**](BudgetLimitStore.md) | JSON array or key=value pairs with the necessary budget information. See the model for the exact specifications. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+
+### Return type
+
+[**models::BudgetLimitSingle**](BudgetLimitSingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded
+- **Accept**: application/vnd.api+json, application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## update_budget
+
+> models::BudgetSingle update_budget(id, budget_update, x_trace_id)
+Update existing budget.
+
+Update existing budget. This endpoint cannot be used to set budget amount limits.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the budget. | [required] |
+**budget_update** | [**BudgetUpdate**](BudgetUpdate.md) | JSON array with updated budget information. See the model for the exact specifications. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+
+### Return type
+
+[**models::BudgetSingle**](BudgetSingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded
+- **Accept**: application/vnd.api+json, application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## update_budget_limit
+
+> models::BudgetLimitSingle update_budget_limit(id, limit_id, budget_limit, x_trace_id)
+Update existing budget limit.
+
+Update existing budget limit.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the budget. The budget limit MUST be associated to the budget ID. | [required] |
+**limit_id** | **String** | The ID of the budget limit. The budget limit MUST be associated to the budget ID. | [required] |
+**budget_limit** | [**BudgetLimit**](BudgetLimit.md) | JSON array with updated budget limit information. See the model for the exact specifications. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+
+### Return type
+
+[**models::BudgetLimitSingle**](BudgetLimitSingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded
+- **Accept**: application/vnd.api+json, application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

firefly-iii-api/docs/CategoriesApi.md

@@ -0,0 +1,243 @@
+# \CategoriesApi
+
+All URIs are relative to *https://demo.firefly-iii.org/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_category**](CategoriesApi.md#delete_category) | **DELETE** /v1/categories/{id} | Delete a category.
+[**get_category**](CategoriesApi.md#get_category) | **GET** /v1/categories/{id} | Get a single category.
+[**list_attachment_by_category**](CategoriesApi.md#list_attachment_by_category) | **GET** /v1/categories/{id}/attachments | Lists all attachments.
+[**list_category**](CategoriesApi.md#list_category) | **GET** /v1/categories | List all categories.
+[**list_transaction_by_category**](CategoriesApi.md#list_transaction_by_category) | **GET** /v1/categories/{id}/transactions | List all transactions in a category.
+[**store_category**](CategoriesApi.md#store_category) | **POST** /v1/categories | Store a new category
+[**update_category**](CategoriesApi.md#update_category) | **PUT** /v1/categories/{id} | Update existing category.
+
+
+
+## delete_category
+
+> delete_category(id, x_trace_id)
+Delete a category.
+
+Delete a category. Transactions will not be removed.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the category. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+
+### Return type
+
+ (empty response body)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## get_category
+
+> models::CategorySingle get_category(id, x_trace_id, start, end)
+Get a single category.
+
+Get a single category.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the category. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**start** | Option<**String**> | A date formatted YYYY-MM-DD, to show spent and earned info.  |  |
+**end** | Option<**String**> | A date formatted YYYY-MM-DD, to show spent and earned info.  |  |
+
+### Return type
+
+[**models::CategorySingle**](CategorySingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.api+json, application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## list_attachment_by_category
+
+> models::AttachmentArray list_attachment_by_category(id, x_trace_id, limit, page)
+Lists all attachments.
+
+Lists all attachments.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the category. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**limit** | Option<**i32**> | Number of items per page. The default pagination is per 50 items. |  |
+**page** | Option<**i32**> | Page number. The default pagination is per 50 items. |  |
+
+### Return type
+
+[**models::AttachmentArray**](AttachmentArray.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.api+json, application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## list_category
+
+> models::CategoryArray list_category(x_trace_id, limit, page)
+List all categories.
+
+List all categories.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**limit** | Option<**i32**> | Number of items per page. The default pagination is per 50 items. |  |
+**page** | Option<**i32**> | Page number. The default pagination is per 50 items. |  |
+
+### Return type
+
+[**models::CategoryArray**](CategoryArray.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.api+json, application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## list_transaction_by_category
+
+> models::TransactionArray list_transaction_by_category(id, x_trace_id, limit, page, start, end, r#type)
+List all transactions in a category.
+
+List all transactions in a category, optionally limited to the date ranges specified.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the category. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+**limit** | Option<**i32**> | Number of items per page. The default pagination is per 50 items. |  |
+**page** | Option<**i32**> | Page number. The default pagination is per 50 items. |  |
+**start** | Option<**String**> | A date formatted YYYY-MM-DD, to limit the result list.  |  |
+**end** | Option<**String**> | A date formatted YYYY-MM-DD, to limit the result list.  |  |
+**r#type** | Option<[**TransactionTypeFilter**](.md)> | Optional filter on the transaction type(s) returned |  |
+
+### Return type
+
+[**models::TransactionArray**](TransactionArray.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.api+json, application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## store_category
+
+> models::CategorySingle store_category(category, x_trace_id)
+Store a new category
+
+Creates a new category. The data required can be submitted as a JSON body or as a list of parameters.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**category** | [**Category**](Category.md) | JSON array or key=value pairs with the necessary category information. See the model for the exact specifications. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+
+### Return type
+
+[**models::CategorySingle**](CategorySingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded
+- **Accept**: application/vnd.api+json, application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+## update_category
+
+> models::CategorySingle update_category(id, category_update, x_trace_id)
+Update existing category.
+
+Update existing category.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **String** | The ID of the category. | [required] |
+**category_update** | [**CategoryUpdate**](CategoryUpdate.md) | JSON array with updated category information. See the model for the exact specifications. | [required] |
+**x_trace_id** | Option<**uuid::Uuid**> | Unique identifier associated with this request. |  |
+
+### Return type
+
+[**models::CategorySingle**](CategorySingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth), [local_bearer_auth](../README.md#local_bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded
+- **Accept**: application/vnd.api+json, application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

firefly-iii-api/docs/Category.md

@@ -0,0 +1,16 @@
+# Category
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | Option<**String**> |  | [optional][readonly]
+**updated_at** | Option<**String**> |  | [optional][readonly]
+**name** | **String** |  | 
+**notes** | Option<**String**> |  | [optional]
+**spent** | Option<[**Vec<models::CategorySpent>**](CategorySpent.md)> |  | [optional][readonly]
+**earned** | Option<[**Vec<models::CategoryEarned>**](CategoryEarned.md)> |  | [optional][readonly]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/CategoryArray.md

@@ -0,0 +1,12 @@
+# CategoryArray
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Vec<models::CategoryRead>**](CategoryRead.md) |  | 
+**meta** | [**models::Meta**](Meta.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/CategoryEarned.md

@@ -0,0 +1,15 @@
+# CategoryEarned
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currency_id** | Option<**String**> |  | [optional]
+**currency_code** | Option<**String**> |  | [optional]
+**currency_symbol** | Option<**String**> |  | [optional]
+**currency_decimal_places** | Option<**i32**> | Number of decimals supported by the currency | [optional]
+**sum** | Option<**String**> | The amount earned. | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/CategoryRead.md

@@ -0,0 +1,13 @@
+# CategoryRead
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**r#type** | **String** | Immutable value | 
+**id** | **String** |  | 
+**attributes** | [**models::Category**](Category.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/CategorySingle.md

@@ -0,0 +1,11 @@
+# CategorySingle
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**models::CategoryRead**](CategoryRead.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/CategorySpent.md

@@ -0,0 +1,15 @@
+# CategorySpent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currency_id** | Option<**String**> |  | [optional]
+**currency_code** | Option<**String**> |  | [optional]
+**currency_symbol** | Option<**String**> |  | [optional]
+**currency_decimal_places** | Option<**i32**> | Number of decimals supported by the currency | [optional]
+**sum** | Option<**String**> | The amount spent. | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

firefly-iii-api/docs/CategoryUpdate.md

@@ -0,0 +1,12 @@
+# CategoryUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**notes** | Option<**String**> |  | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+