firefly-iii 0.3.0

Rust API client for firefly-iii
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
# Rust API client for firefly-iii

[![Crates.io](https://img.shields.io/crates/v/firefly-iii.svg?maxAge=2592000)](https://crates.io/crates/firefly-iii)
[![Documentation](https://docs.rs/firefly-iii/badge.svg)](https://docs.rs/firefly-iii)

This is the official 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. This version of the API is live from version v5.6.11 and onwards. You may use the \"Authorize\" button to try the API below.

## 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: v6.4.14
- Package version: 0.2.5
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`
For more information, please visit [https://firefly-iii.org]https://firefly-iii.org

## Installation

Put the package under your project folder and add the following to `Cargo.toml` under `[dependencies]`:

```
firefly-iii = "0.3.0"
```

## 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.
*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_subscriptions_ac**]docs/AutocompleteApi.md#get_subscriptions_ac | **GET** /v1/autocomplete/subscriptions | Returns all subscriptions 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_budgets**]docs/AvailableBudgetsApi.md#list_available_budgets | **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* | [**list_transaction_without_budget**]docs/BudgetsApi.md#list_transaction_without_budget | **GET** /v1/budgets/transactions-without-budget | All transactions without a budget.
*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.
*ChartsApi* | [**get_chart_balance**]docs/ChartsApi.md#get_chart_balance | **GET** /v1/chart/balance/balance | Dashboard chart with balance information.
*ChartsApi* | [**get_chart_budget_overview**]docs/ChartsApi.md#get_chart_budget_overview | **GET** /v1/chart/budget/overview | Dashboard chart with budget information.
*ChartsApi* | [**get_chart_category_overview**]docs/ChartsApi.md#get_chart_category_overview | **GET** /v1/chart/category/overview | Dashboard chart with category 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* | [**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_primary_currency**]docs/CurrenciesApi.md#get_primary_currency | **GET** /v1/currencies/primary | Get the primary currency of the current administration.
*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* | [**primary_currency**]docs/CurrenciesApi.md#primary_currency | **POST** /v1/currencies/{code}/primary | Make currency primary 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.
*CurrencyExchangeRatesApi* | [**delete_specific_currency_exchange_rate**]docs/CurrencyExchangeRatesApi.md#delete_specific_currency_exchange_rate | **DELETE** /v1/exchange-rates/{id} | Delete a specific currency exchange rate.
*CurrencyExchangeRatesApi* | [**delete_specific_currency_exchange_rate_on_date**]docs/CurrencyExchangeRatesApi.md#delete_specific_currency_exchange_rate_on_date | **DELETE** /v1/exchange-rates/{from}/{to}/{date} | Delete the currency exchange rate from 'from' to 'to' on the specified date.
*CurrencyExchangeRatesApi* | [**delete_specific_currency_exchange_rates**]docs/CurrencyExchangeRatesApi.md#delete_specific_currency_exchange_rates | **DELETE** /v1/exchange-rates/{from}/{to} | Deletes ALL currency exchange rates from 'from' to 'to'.
*CurrencyExchangeRatesApi* | [**list_currency_exchange_rates**]docs/CurrencyExchangeRatesApi.md#list_currency_exchange_rates | **GET** /v1/exchange-rates | List all exchange rates that Firefly III knows.
*CurrencyExchangeRatesApi* | [**list_specific_currency_exchange_rate**]docs/CurrencyExchangeRatesApi.md#list_specific_currency_exchange_rate | **GET** /v1/exchange-rates/{id} | List a single specific exchange rate.
*CurrencyExchangeRatesApi* | [**list_specific_currency_exchange_rate_on_date**]docs/CurrencyExchangeRatesApi.md#list_specific_currency_exchange_rate_on_date | **GET** /v1/exchange-rates/{from}/{to}/{date} | List the exchange rate for the from and to-currency on the requested date.
*CurrencyExchangeRatesApi* | [**list_specific_currency_exchange_rates**]docs/CurrencyExchangeRatesApi.md#list_specific_currency_exchange_rates | **GET** /v1/exchange-rates/{from}/{to} | List all exchange rates from/to the mentioned currencies.
*CurrencyExchangeRatesApi* | [**store_currency_exchange_rate**]docs/CurrencyExchangeRatesApi.md#store_currency_exchange_rate | **POST** /v1/exchange-rates | Store a new currency exchange rate.
*CurrencyExchangeRatesApi* | [**store_currency_exchange_rates_by_date**]docs/CurrencyExchangeRatesApi.md#store_currency_exchange_rates_by_date | **POST** /v1/exchange-rates/by-date/{date} | Store new currency exchange rates under this date
*CurrencyExchangeRatesApi* | [**store_currency_exchange_rates_by_pair**]docs/CurrencyExchangeRatesApi.md#store_currency_exchange_rates_by_pair | **POST** /v1/exchange-rates/by-currencies/{from}/{to} | Store new currency exchange rates under this from/to pair.
*CurrencyExchangeRatesApi* | [**update_currency_exchange_rate**]docs/CurrencyExchangeRatesApi.md#update_currency_exchange_rate | **PUT** /v1/exchange-rates/{id} | Update existing currency exchange rate.
*CurrencyExchangeRatesApi* | [**update_currency_exchange_rate_by_date**]docs/CurrencyExchangeRatesApi.md#update_currency_exchange_rate_by_date | **PUT** /v1/exchange-rates/{from}/{to}/{date} | Update existing currency exchange rate.
*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 object 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* | [**trigger_recurrence_recurrence**]docs/RecurrencesApi.md#trigger_recurrence_recurrence | **POST** /v1/recurrences/{id}/trigger | Trigger the creation of a transaction for a specific 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/
*UserGroupsApi* | [**get_user_group**]docs/UserGroupsApi.md#get_user_group | **GET** /v1/user-groups/{id} | Get a single user group.
*UserGroupsApi* | [**list_user_groups**]docs/UserGroupsApi.md#list_user_groups | **GET** /v1/user-groups | List all the user groups available to this user. 
*UserGroupsApi* | [**update_user_group**]docs/UserGroupsApi.md#update_user_group | **PUT** /v1/user-groups/{id} | Update an existing user group.
*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_webhook**]docs/WebhooksApi.md#submit_webhook | **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

 - [AccountArray]docs/AccountArray.md
 - [AccountProperties]docs/AccountProperties.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
 - [ArrayEntryWithCurrencyAndSum]docs/ArrayEntryWithCurrencyAndSum.md
 - [AttachableType]docs/AttachableType.md
 - [AttachmentArray]docs/AttachmentArray.md
 - [AttachmentProperties]docs/AttachmentProperties.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
 - [AvailableBudgetArray]docs/AvailableBudgetArray.md
 - [AvailableBudgetProperties]docs/AvailableBudgetProperties.md
 - [AvailableBudgetRead]docs/AvailableBudgetRead.md
 - [AvailableBudgetSingle]docs/AvailableBudgetSingle.md
 - [BadRequestResponse]docs/BadRequestResponse.md
 - [BasicSummaryEntry]docs/BasicSummaryEntry.md
 - [BillArray]docs/BillArray.md
 - [BillProperties]docs/BillProperties.md
 - [BillPropertiesPaidDatesInner]docs/BillPropertiesPaidDatesInner.md
 - [BillRead]docs/BillRead.md
 - [BillRepeatFrequency]docs/BillRepeatFrequency.md
 - [BillSingle]docs/BillSingle.md
 - [BillStore]docs/BillStore.md
 - [BillUpdate]docs/BillUpdate.md
 - [BudgetArray]docs/BudgetArray.md
 - [BudgetLimitArray]docs/BudgetLimitArray.md
 - [BudgetLimitProperties]docs/BudgetLimitProperties.md
 - [BudgetLimitRead]docs/BudgetLimitRead.md
 - [BudgetLimitSingle]docs/BudgetLimitSingle.md
 - [BudgetLimitStore]docs/BudgetLimitStore.md
 - [BudgetLimitUpdate]docs/BudgetLimitUpdate.md
 - [BudgetProperties]docs/BudgetProperties.md
 - [BudgetRead]docs/BudgetRead.md
 - [BudgetSingle]docs/BudgetSingle.md
 - [BudgetStore]docs/BudgetStore.md
 - [BudgetUpdate]docs/BudgetUpdate.md
 - [CategoryArray]docs/CategoryArray.md
 - [CategoryProperties]docs/CategoryProperties.md
 - [CategoryRead]docs/CategoryRead.md
 - [CategorySingle]docs/CategorySingle.md
 - [CategoryStore]docs/CategoryStore.md
 - [CategoryUpdate]docs/CategoryUpdate.md
 - [ChartDataPoint]docs/ChartDataPoint.md
 - [ChartDataSet]docs/ChartDataSet.md
 - [ChartDatasetPeriodProperty]docs/ChartDatasetPeriodProperty.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
 - [CurrencyArray]docs/CurrencyArray.md
 - [CurrencyExchangeProperties]docs/CurrencyExchangeProperties.md
 - [CurrencyExchangeRateArray]docs/CurrencyExchangeRateArray.md
 - [CurrencyExchangeRateRead]docs/CurrencyExchangeRateRead.md
 - [CurrencyExchangeRateSingle]docs/CurrencyExchangeRateSingle.md
 - [CurrencyExchangeRateStore]docs/CurrencyExchangeRateStore.md
 - [CurrencyExchangeRateStoreByDate]docs/CurrencyExchangeRateStoreByDate.md
 - [CurrencyExchangeRateUpdate]docs/CurrencyExchangeRateUpdate.md
 - [CurrencyExchangeRateUpdateNoDate]docs/CurrencyExchangeRateUpdateNoDate.md
 - [CurrencyProperties]docs/CurrencyProperties.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
 - [PiggyBankAccountRead]docs/PiggyBankAccountRead.md
 - [PiggyBankAccountStore]docs/PiggyBankAccountStore.md
 - [PiggyBankAccountUpdate]docs/PiggyBankAccountUpdate.md
 - [PiggyBankArray]docs/PiggyBankArray.md
 - [PiggyBankEventArray]docs/PiggyBankEventArray.md
 - [PiggyBankEventProperties]docs/PiggyBankEventProperties.md
 - [PiggyBankEventRead]docs/PiggyBankEventRead.md
 - [PiggyBankProperties]docs/PiggyBankProperties.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
 - [RecurrenceArray]docs/RecurrenceArray.md
 - [RecurrenceProperties]docs/RecurrenceProperties.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
 - [UserGroupArray]docs/UserGroupArray.md
 - [UserGroupRead]docs/UserGroupRead.md
 - [UserGroupReadAttributes]docs/UserGroupReadAttributes.md
 - [UserGroupReadMembers]docs/UserGroupReadMembers.md
 - [UserGroupReadRole]docs/UserGroupReadRole.md
 - [UserGroupSingle]docs/UserGroupSingle.md
 - [UserGroupUpdate]docs/UserGroupUpdate.md
 - [UserRead]docs/UserRead.md
 - [UserRoleProperty]docs/UserRoleProperty.md
 - [UserSingle]docs/UserSingle.md
 - [ValidationErrorResponse]docs/ValidationErrorResponse.md
 - [ValidationErrorResponseErrors]docs/ValidationErrorResponseErrors.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
 - [WebhookProperties]docs/WebhookProperties.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