FireflyIIIClient - the Ruby gem for the Firefly III API
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 v4.7.9 and onwards. You may use the "Authorize" button to try the API below.
This SDK is automatically generated by the OpenAPI Generator project:
To build the Ruby code into a gem:
gem build firefly-iii-client.gemspec
Then either install the gem locally:
gem install ./firefly_iii_client-1.0.0.gem
(for development, run gem install --dev ./openapi_client-1.0.0.gem to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'openapi_client', '~> 1.0.0'
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
gem 'openapi_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
Include the Ruby code directly using -I as follows:
ruby -Ilib script.rb
Please follow the installation procedure and then run the following code:
# Load the gem
require 'firefly_iii_client'
# Setup authorization
FireflyIIIClient.configure do |config|
# Configure OAuth2 access token for authorization: firefly_iii_auth
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = FireflyIIIClient::AboutApi.new
begin
#System information end point.
result = api_instance.get_about
p result
rescue FireflyIIIClient::ApiError => e
puts "Exception when calling AboutApi->get_about: #{e}"
end
All URIs are relative to https://demo.firefly-iii.org
| Class | Method | HTTP request | Description |
|---|---|---|---|
| FireflyIIIClient::AboutApi | get_about | GET /api/v1/about | System information end point. |
| FireflyIIIClient::AboutApi | get_current_user | GET /api/v1/about/user | Currently authenticated user endpoint. |
| FireflyIIIClient::AccountsApi | delete_account | DELETE /api/v1/accounts/{id} | Permanently delete account. |
| FireflyIIIClient::AccountsApi | get_account | GET /api/v1/accounts/{id} | Get single account. |
| FireflyIIIClient::AccountsApi | list_account | GET /api/v1/accounts | List all accounts. |
| FireflyIIIClient::AccountsApi | list_piggy_bank_by_account | GET /api/v1/accounts/{id}/piggy_banks | List all piggy banks related to the account. |
| FireflyIIIClient::AccountsApi | list_transaction_by_account | GET /api/v1/accounts/{id}/transactions | List all transactions related to the account. |
| FireflyIIIClient::AccountsApi | store_account | POST /api/v1/accounts | Create new account. |
| FireflyIIIClient::AccountsApi | update_account | PUT /api/v1/accounts/{id} | Update existing account. |
| FireflyIIIClient::AttachmentsApi | delete_attachment | DELETE /api/v1/attachments/{id} | Delete an attachment. |
| FireflyIIIClient::AttachmentsApi | download_attachment | GET /api/v1/attachments/{id}/download | Download a single attachment. |
| FireflyIIIClient::AttachmentsApi | get_attachment | GET /api/v1/attachments/{id} | Get a single attachment. |
| FireflyIIIClient::AttachmentsApi | list_attachment | GET /api/v1/attachments | List all attachments. |
| FireflyIIIClient::AttachmentsApi | store_attachment | POST /api/v1/attachments | Store a new attachment. |
| FireflyIIIClient::AttachmentsApi | update_attachment | PUT /api/v1/attachments/{id} | Update existing attachment. |
| FireflyIIIClient::AttachmentsApi | upload_attachment | POST /api/v1/attachments/{id}/upload | Upload an attachment. |
| FireflyIIIClient::AvailableBudgetsApi | delete_available_budget | DELETE /api/v1/available_budgets/{id} | Delete an available budget. |
| FireflyIIIClient::AvailableBudgetsApi | get_available_budget | GET /api/v1/available_budgets/{id} | Get a single available budget. |
| FireflyIIIClient::AvailableBudgetsApi | list_available_budget | GET /api/v1/available_budgets | List all available budget amounts. |
| FireflyIIIClient::AvailableBudgetsApi | store_available_budget | POST /api/v1/available_budgets | Store a new available budget |
| FireflyIIIClient::AvailableBudgetsApi | update_available_budget | PUT /api/v1/available_budgets/{id} | Update existing available budget, to change for example the date range of the amount or the amount itself. |
| FireflyIIIClient::BillsApi | delete_bill | DELETE /api/v1/bills/{id} | Delete a bill. |
| FireflyIIIClient::BillsApi | get_bill | GET /api/v1/bills/{id} | Get a single bill. |
| FireflyIIIClient::BillsApi | list_attachment_by_bill | GET /api/v1/bills/{id}/attachments | List all attachments uploaded to the bill. |
| FireflyIIIClient::BillsApi | list_bill | GET /api/v1/bills | List all bills. |
| FireflyIIIClient::BillsApi | list_rule_by_bill | GET /api/v1/bills/{id}/rules | List all rules associated with the bill. |
| FireflyIIIClient::BillsApi | list_transaction_by_bill | GET /api/v1/bills/{id}/transactions | List all transactions associated with the bill. |
| FireflyIIIClient::BillsApi | store_bill | POST /api/v1/bills | Store a new bill |
| FireflyIIIClient::BillsApi | update_bill | PUT /api/v1/bills/{id} | Update existing bill. |
| FireflyIIIClient::BudgetsApi | delete_budget | DELETE /api/v1/budgets/{id} | Delete a budget. |
| FireflyIIIClient::BudgetsApi | delete_budget_limit | DELETE /api/v1/budgets/limits/{id} | Delete a budget limit. |
| FireflyIIIClient::BudgetsApi | get_budget | GET /api/v1/budgets/{id} | Get a single budget. |
| FireflyIIIClient::BudgetsApi | get_budget_limit | GET /api/v1/budgets/limits/{id} | Get single budget limit. |
| FireflyIIIClient::BudgetsApi | list_budget | GET /api/v1/budgets | List all budgets. |
| FireflyIIIClient::BudgetsApi | list_budget_limit_by_budget | GET /api/v1/budgets/{id}/limits | Get all limits |
| FireflyIIIClient::BudgetsApi | list_transaction_by_budget | GET /api/v1/budgets/{id}/transactions | All transactions to a budget. |
| FireflyIIIClient::BudgetsApi | list_transaction_by_budget_limit | GET /api/v1/budgets/limits/{id}/transactions | List all transactions by a budget limit ID. |
| FireflyIIIClient::BudgetsApi | store_budget | POST /api/v1/budgets | Store a new budget |
| FireflyIIIClient::BudgetsApi | store_budget_limit | POST /api/v1/budgets/{id}/limits | Store new budget limit. |
| FireflyIIIClient::BudgetsApi | update_budget | PUT /api/v1/budgets/{id} | Update existing budget. |
| FireflyIIIClient::BudgetsApi | update_budget_limit | PUT /api/v1/budgets/limits/{id} | Update existing budget limit. |
| FireflyIIIClient::CategoriesApi | delete_category | DELETE /api/v1/categories/{id} | Delete a category. |
| FireflyIIIClient::CategoriesApi | get_category | GET /api/v1/categories/{id} | Get a single category. |
| FireflyIIIClient::CategoriesApi | list_category | GET /api/v1/categories | List all categories. |
| FireflyIIIClient::CategoriesApi | list_transaction_by_category | GET /api/v1/categories/{id}/transactions | List all transactions in a category. |
| FireflyIIIClient::CategoriesApi | store_category | POST /api/v1/categories | Store a new category |
| FireflyIIIClient::CategoriesApi | update_category | PUT /api/v1/categories/{id} | Update existing category. |
| FireflyIIIClient::ChartsApi | get_chart_ab_overview | GET /api/v1/chart/ab/overview/{id} | Dashboard chart with an overview of the available budget. |
| FireflyIIIClient::ChartsApi | get_chart_account_expense | GET /api/v1/chart/account/expense | Dashboard chart with expense account balance information. |
| FireflyIIIClient::ChartsApi | get_chart_account_overview | GET /api/v1/chart/account/overview | Dashboard chart with asset account balance information. |
| FireflyIIIClient::ChartsApi | get_chart_account_revenue | GET /api/v1/chart/account/revenue | Dashboard chart with revenue account balance information. |
| FireflyIIIClient::ChartsApi | get_chart_category_overview | GET /api/v1/chart/category/overview | Dashboard chart with an overview of the users categories. |
| FireflyIIIClient::ConfigurationApi | get_configuration | GET /api/v1/configuration | Get Firefly III system configuration. |
| FireflyIIIClient::ConfigurationApi | set_configuration | POST /api/v1/configuration/{name} | Update configuration |
| FireflyIIIClient::CurrenciesApi | default_currency | POST /api/v1/currencies/{code}/default | Make currency default currency. |
| FireflyIIIClient::CurrenciesApi | delete_currency | DELETE /api/v1/currencies/{code} | Delete a currency. |
| FireflyIIIClient::CurrenciesApi | disable_currency | POST /api/v1/currencies/{code}/disable | Disable a currency. |
| FireflyIIIClient::CurrenciesApi | enable_currency | POST /api/v1/currencies/{code}/enable | Enable a single currency. |
| FireflyIIIClient::CurrenciesApi | get_currency | GET /api/v1/currencies/{code} | Get a single currency. |
| FireflyIIIClient::CurrenciesApi | list_account_by_currency | GET /api/v1/currencies/{code}/accounts | List all accounts with this currency. |
| FireflyIIIClient::CurrenciesApi | list_available_budget_by_currency | GET /api/v1/currencies/{code}/available_budgets | List all available budgets with this currency. |
| FireflyIIIClient::CurrenciesApi | list_bill_by_currency | GET /api/v1/currencies/{code}/bills | List all bills with this currency. |
| FireflyIIIClient::CurrenciesApi | list_budget_limit_by_currency | GET /api/v1/currencies/{code}/budget_limits | List all budget limits with this currency |
| FireflyIIIClient::CurrenciesApi | list_currency | GET /api/v1/currencies | List all currencies. |
| FireflyIIIClient::CurrenciesApi | list_exchange_rate_by_currency | GET /api/v1/currencies/{code}/cer | List all known exchange rates with (from or to) this currency. |
| FireflyIIIClient::CurrenciesApi | list_recurrence_by_currency | GET /api/v1/currencies/{code}/recurrences | List all recurring transactions with this currency. |
| FireflyIIIClient::CurrenciesApi | list_rule_by_currency | GET /api/v1/currencies/{code}/rules | List all rules with this currency. |
| FireflyIIIClient::CurrenciesApi | list_transaction_by_currency | GET /api/v1/currencies/{code}/transactions | List all transactions with this currency. |
| FireflyIIIClient::CurrenciesApi | store_currency | POST /api/v1/currencies | Store a new currency |
| FireflyIIIClient::CurrenciesApi | update_currency | PUT /api/v1/currencies/{code} | Update existing currency. |
| FireflyIIIClient::CurrencyExchangeRatesApi | get_exchange_rate | GET /api/v1/cer | Get an exchange rate. |
| FireflyIIIClient::ImportApi | get_import | GET /api/v1/import/{key} | Show info on a single import |
| FireflyIIIClient::ImportApi | list_import | GET /api/v1/import/list | List al imports |
| FireflyIIIClient::ImportApi | list_transaction_by_import | GET /api/v1/import/{key}/transactions | List all transactions related to the import job. The correlation is made through the tag. |
| FireflyIIIClient::LinksApi | delete_link_type | DELETE /api/v1/link_types/{id} | Permanently delete link type. |
| FireflyIIIClient::LinksApi | delete_transaction_link | DELETE /api/v1/transaction_links/{id} | Permanently delete link between transactions. |
| FireflyIIIClient::LinksApi | get_link_type | GET /api/v1/link_types/{id} | Get single a link type. |
| FireflyIIIClient::LinksApi | get_transaction_link | GET /api/v1/transaction_links/{id} | Get a single link. |
| FireflyIIIClient::LinksApi | list_link_type | GET /api/v1/link_types | List all types of links. |
| FireflyIIIClient::LinksApi | list_transaction_by_link_type | GET /api/v1/link_types/{id}/transactions | List all transactions under this link type. |
| FireflyIIIClient::LinksApi | list_transaction_link | GET /api/v1/transaction_links | List all transaction links. |
| FireflyIIIClient::LinksApi | store_link_type | POST /api/v1/link_types | Create a new link type |
| FireflyIIIClient::LinksApi | store_transaction_link | POST /api/v1/transaction_links | Create a new link between transactions |
| FireflyIIIClient::LinksApi | update_link_type | PUT /api/v1/link_types/{id} | Update existing link type. |
| FireflyIIIClient::LinksApi | update_transaction_link | PUT /api/v1/transaction_links/{id} | Update an existing link between transactions. |
| FireflyIIIClient::PiggyBanksApi | delete_piggy_bank | DELETE /api/v1/piggy_banks/{id} | Delete a piggy bank. |
| FireflyIIIClient::PiggyBanksApi | get_piggy_bank | GET /api/v1/piggy_banks/{id} | Get a single piggy bank. |
| FireflyIIIClient::PiggyBanksApi | list_event_by_piggy_bank | GET /api/v1/piggy_banks/{id}/events | List all events linked to a piggy bank. |
| FireflyIIIClient::PiggyBanksApi | list_piggy_bank | GET /api/v1/piggy_banks | List all piggy banks. |
| FireflyIIIClient::PiggyBanksApi | store_piggy_bank | POST /api/v1/piggy_banks | Store a new piggy bank |
| FireflyIIIClient::PiggyBanksApi | update_piggy_bank | PUT /api/v1/piggy_banks/{id} | Update existing piggy bank. |
| FireflyIIIClient::PreferencesApi | get_preference | GET /api/v1/preferences/{name} | Return a single preference. |
| FireflyIIIClient::PreferencesApi | list_preference | GET /api/v1/preferences | List all users preferences. |
| FireflyIIIClient::PreferencesApi | update_preference | PUT /api/v1/preferences/{name} | Update preference |
| FireflyIIIClient::RecurrencesApi | delete_recurrence | DELETE /api/v1/recurrences/{id} | Delete a recurring transaction. |
| FireflyIIIClient::RecurrencesApi | get_recurrence | GET /api/v1/recurrences/{id} | Get a single recurring transaction. |
| FireflyIIIClient::RecurrencesApi | list_recurrence | GET /api/v1/recurrences | List all recurring transactions. |
| FireflyIIIClient::RecurrencesApi | list_transaction_by_recurrence | GET /api/v1/recurrences/{id}/transactions | List all transactions created by a recurring transaction. |
| FireflyIIIClient::RecurrencesApi | store_recurrence | POST /api/v1/recurrences | Store a new recurring transaction |
| FireflyIIIClient::RecurrencesApi | trigger_recurrence | POST /api/v1/recurrences/trigger | Trigger the creation of recurring transactions (like a cron job). |
| FireflyIIIClient::RecurrencesApi | update_recurrence | PUT /api/v1/recurrences/{id} | Update existing recurring transaction. |
| FireflyIIIClient::RuleGroupsApi | delete_rule_group | DELETE /api/v1/rule_groups/{id} | Delete a rule group. |
| FireflyIIIClient::RuleGroupsApi | fire_rule_group | POST /api/v1/rule_groups/{id}/trigger | Fire the rule group on your transactions. |
| FireflyIIIClient::RuleGroupsApi | get_rule_group | GET /api/v1/rule_groups/{id} | Get a single rule group. |
| FireflyIIIClient::RuleGroupsApi | list_rule_by_group | GET /api/v1/rule_groups/{id}/rules | List rules in this rule group. |
| FireflyIIIClient::RuleGroupsApi | list_rule_group | GET /api/v1/rule_groups | List all rule groups. |
| FireflyIIIClient::RuleGroupsApi | store_rule_group | POST /api/v1/rule_groups | Store a new rule group. |
| FireflyIIIClient::RuleGroupsApi | test_rule_group | GET /api/v1/rule_groups/{id}/test | Test which transactions would be hit by the rule group. No changes will be made. |
| FireflyIIIClient::RuleGroupsApi | update_rule_group | PUT /api/v1/rule_groups/{id} | Update existing rule group. |
| FireflyIIIClient::RulesApi | delete_rule | DELETE /api/v1/rules/{id} | Delete an rule. |
| FireflyIIIClient::RulesApi | fire_rule | POST /api/v1/rules/{id}/trigger | Fire the rule on your transactions. |
| FireflyIIIClient::RulesApi | get_rule | GET /api/v1/rules/{id} | Get a single rule. |
| FireflyIIIClient::RulesApi | list_rule | GET /api/v1/rules | List all rules. |
| FireflyIIIClient::RulesApi | store_rule | POST /api/v1/rules | Store a new rule |
| FireflyIIIClient::RulesApi | test_rule | GET /api/v1/rules/{id}/test | Test which transactions would be hit by the rule. No changes will be made. |
| FireflyIIIClient::RulesApi | update_rule | PUT /api/v1/rules/{id} | Update existing rule. |
| FireflyIIIClient::SummaryApi | get_basic_summary | GET /api/v1/summary/basic | Returns basic sums of the users data. |
| FireflyIIIClient::TagsApi | delete_tag | DELETE /api/v1/tags/{tag} | Delete an tag. |
| FireflyIIIClient::TagsApi | get_tag | GET /api/v1/tags/{tag} | Get a single tag. |
| FireflyIIIClient::TagsApi | get_tag_cloud | GET /api/v1/tag-cloud | Returns a basic tag cloud. |
| FireflyIIIClient::TagsApi | list_tag | GET /api/v1/tags | List all tags. |
| FireflyIIIClient::TagsApi | list_transaction_by_tag | GET /api/v1/tags/{tag}/transactions | List all transactions with this tag. |
| FireflyIIIClient::TagsApi | store_tag | POST /api/v1/tags | Store a new tag |
| FireflyIIIClient::TagsApi | update_tag | PUT /api/v1/tags/{tag} | Update existing tag. |
| FireflyIIIClient::TransactionsApi | delete_transaction | DELETE /api/v1/transactions/{id} | Delete a transaction. |
| FireflyIIIClient::TransactionsApi | get_transaction | GET /api/v1/transactions/{id} | Get a single transaction. |
| FireflyIIIClient::TransactionsApi | get_transaction_by_journal | GET /api/v1/transaction-journals/{id} | Get a single transaction, based on one of the underlying transaction journals. |
| FireflyIIIClient::TransactionsApi | list_attachment_by_transaction | GET /api/v1/transactions/{id}/attachments | Lists all attachments. |
| FireflyIIIClient::TransactionsApi | list_event_by_transaction | GET /api/v1/transactions/{id}/piggy_bank_events | Lists all piggy bank events. |
| FireflyIIIClient::TransactionsApi | list_transaction | GET /api/v1/transactions | List all the user's transactions. |
| FireflyIIIClient::TransactionsApi | store_transaction | POST /api/v1/transactions | Store a new transaction |
| FireflyIIIClient::TransactionsApi | update_transaction | PUT /api/v1/transactions/{id} | Update existing transaction. |
| FireflyIIIClient::UsersApi | delete_user | DELETE /api/v1/users/{id} | Delete a user. |
| FireflyIIIClient::UsersApi | get_user | GET /api/v1/users/{id} | Get a single user. |
| FireflyIIIClient::UsersApi | list_user | GET /api/v1/users | List all users. |
| FireflyIIIClient::UsersApi | store_user | POST /api/v1/users | Store a new user |
| FireflyIIIClient::UsersApi | update_user | PUT /api/v1/users/{id} | Update an existing user's information. |
FAQs
Unknown package
We found that firefly-iii-client demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.