FireflyIII.Net - the C# library for the Firefly III API

This is the documentation for the Firefly III .Net 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 (API version 0.10.4).

This C# SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.10.4 with fixes applied (& upstreamed)
• Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen For more information, please visit https://firefly-iii.org

Frameworks supported

• .NET Core >=1.0
• .NET Framework >=4.6
• Mono/Xamarin >=vNext

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using FireflyIII.Api;
using FireflyIII.Client;
using FireflyIII.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration.Default.BasePath = "https://demo.firefly-iii.org";
            // Create a personal access token or OAuth2 token for authorization: firefly_iii_auth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AboutApi(Configuration.Default);

            try
            {
                // System information end point.
                SystemInfo result = apiInstance.GetAbout();
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AboutApi.GetAbout: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://demo.firefly-iii.org

Class	Method	HTTP request	Description
AboutApi	GetAbout	GET /api/v1/about	System information end point.
AboutApi	GetCurrentUser	GET /api/v1/about/user	Currently authenticated user endpoint.
AccountsApi	DeleteAccount	DELETE /api/v1/accounts/{id}	Permanently delete account.
AccountsApi	GetAccount	GET /api/v1/accounts/{id}	Get single account.
AccountsApi	ListAccount	GET /api/v1/accounts	List all accounts.
AccountsApi	ListPiggyBankByAccount	GET /api/v1/accounts/{id}/piggy_banks	List all piggy banks related to the account.
AccountsApi	ListTransactionByAccount	GET /api/v1/accounts/{id}/transactions	List all transactions related to the account.
AccountsApi	StoreAccount	POST /api/v1/accounts	Create new account.
AccountsApi	UpdateAccount	PUT /api/v1/accounts/{id}	Update existing account.
AttachmentsApi	DeleteAttachment	DELETE /api/v1/attachments/{id}	Delete an attachment.
AttachmentsApi	DownloadAttachment	GET /api/v1/attachments/{id}/download	Download a single attachment.
AttachmentsApi	GetAttachment	GET /api/v1/attachments/{id}	Get a single attachment.
AttachmentsApi	ListAttachment	GET /api/v1/attachments	List all attachments.
AttachmentsApi	StoreAttachment	POST /api/v1/attachments	Store a new attachment.
AttachmentsApi	UpdateAttachment	PUT /api/v1/attachments/{id}	Update existing attachment.
AttachmentsApi	UploadAttachment	POST /api/v1/attachments/{id}/upload	Upload an attachment.
AvailableBudgetsApi	DeleteAvailableBudget	DELETE /api/v1/available_budgets/{id}	Delete an available budget.
AvailableBudgetsApi	GetAvailableBudget	GET /api/v1/available_budgets/{id}	Get a single available budget.
AvailableBudgetsApi	ListAvailableBudget	GET /api/v1/available_budgets	List all available budget amounts.
AvailableBudgetsApi	StoreAvailableBudget	POST /api/v1/available_budgets	Store a new available budget
AvailableBudgetsApi	UpdateAvailableBudget	PUT /api/v1/available_budgets/{id}	Update existing available budget, to change for example the date range of the amount or the amount itself.
BillsApi	DeleteBill	DELETE /api/v1/bills/{id}	Delete a bill.
BillsApi	GetBill	GET /api/v1/bills/{id}	Get a single bill.
BillsApi	ListAttachmentByBill	GET /api/v1/bills/{id}/attachments	List all attachments uploaded to the bill.
BillsApi	ListBill	GET /api/v1/bills	List all bills.
BillsApi	ListRuleByBill	GET /api/v1/bills/{id}/rules	List all rules associated with the bill.
BillsApi	ListTransactionByBill	GET /api/v1/bills/{id}/transactions	List all transactions associated with the bill.
BillsApi	StoreBill	POST /api/v1/bills	Store a new bill
BillsApi	UpdateBill	PUT /api/v1/bills/{id}	Update existing bill.
BudgetsApi	DeleteBudget	DELETE /api/v1/budgets/{id}	Delete a budget.
BudgetsApi	DeleteBudgetLimit	DELETE /api/v1/budgets/limits/{id}	Delete a budget limit.
BudgetsApi	GetBudget	GET /api/v1/budgets/{id}	Get a single budget.
BudgetsApi	GetBudgetLimit	GET /api/v1/budgets/limits/{id}	Get single budget limit.
BudgetsApi	ListBudget	GET /api/v1/budgets	List all budgets.
BudgetsApi	ListBudgetLimitByBudget	GET /api/v1/budgets/{id}/limits	Get all limits
BudgetsApi	ListTransactionByBudget	GET /api/v1/budgets/{id}/transactions	All transactions to a budget.
BudgetsApi	ListTransactionByBudgetLimit	GET /api/v1/budgets/limits/{id}/transactions	List all transactions by a budget limit ID.
BudgetsApi	StoreBudget	POST /api/v1/budgets	Store a new budget
BudgetsApi	StoreBudgetLimit	POST /api/v1/budgets/{id}/limits	Store new budget limit.
BudgetsApi	UpdateBudget	PUT /api/v1/budgets/{id}	Update existing budget.
BudgetsApi	UpdateBudgetLimit	PUT /api/v1/budgets/limits/{id}	Update existing budget limit.
CategoriesApi	DeleteCategory	DELETE /api/v1/categories/{id}	Delete a category.
CategoriesApi	GetCategory	GET /api/v1/categories/{id}	Get a single category.
CategoriesApi	ListCategory	GET /api/v1/categories	List all categories.
CategoriesApi	ListTransactionByCategory	GET /api/v1/categories/{id}/transactions	List all transactions in a category.
CategoriesApi	StoreCategory	POST /api/v1/categories	Store a new category
CategoriesApi	UpdateCategory	PUT /api/v1/categories/{id}	Update existing category.
ChartsApi	GetChartABOverview	GET /api/v1/chart/ab/overview/{id}	Dashboard chart with an overview of the available budget.
ChartsApi	GetChartAccountExpense	GET /api/v1/chart/account/expense	Dashboard chart with expense account balance information.
ChartsApi	GetChartAccountOverview	GET /api/v1/chart/account/overview	Dashboard chart with asset account balance information.
ChartsApi	GetChartAccountRevenue	GET /api/v1/chart/account/revenue	Dashboard chart with revenue account balance information.
ChartsApi	GetChartCategoryOverview	GET /api/v1/chart/category/overview	Dashboard chart with an overview of the users categories.
ConfigurationApi	GetConfiguration	GET /api/v1/configuration	Get Firefly III system configuration.
ConfigurationApi	SetConfiguration	POST /api/v1/configuration/{name}	Update configuration
CurrenciesApi	DefaultCurrency	POST /api/v1/currencies/{code}/default	Make currency default currency.
CurrenciesApi	DeleteCurrency	DELETE /api/v1/currencies/{code}	Delete a currency.
CurrenciesApi	DisableCurrency	POST /api/v1/currencies/{code}/disable	Disable a currency.
CurrenciesApi	EnableCurrency	POST /api/v1/currencies/{code}/enable	Enable a single currency.
CurrenciesApi	GetCurrency	GET /api/v1/currencies/{code}	Get a single currency.
CurrenciesApi	ListAccountByCurrency	GET /api/v1/currencies/{code}/accounts	List all accounts with this currency.
CurrenciesApi	ListAvailableBudgetByCurrency	GET /api/v1/currencies/{code}/available_budgets	List all available budgets with this currency.
CurrenciesApi	ListBillByCurrency	GET /api/v1/currencies/{code}/bills	List all bills with this currency.
CurrenciesApi	ListBudgetLimitByCurrency	GET /api/v1/currencies/{code}/budget_limits	List all budget limits with this currency
CurrenciesApi	ListCurrency	GET /api/v1/currencies	List all currencies.
CurrenciesApi	ListExchangeRateByCurrency	GET /api/v1/currencies/{code}/cer	List all known exchange rates with (from or to) this currency.
CurrenciesApi	ListRecurrenceByCurrency	GET /api/v1/currencies/{code}/recurrences	List all recurring transactions with this currency.
CurrenciesApi	ListRuleByCurrency	GET /api/v1/currencies/{code}/rules	List all rules with this currency.
CurrenciesApi	ListTransactionByCurrency	GET /api/v1/currencies/{code}/transactions	List all transactions with this currency.
CurrenciesApi	StoreCurrency	POST /api/v1/currencies	Store a new currency
CurrenciesApi	UpdateCurrency	PUT /api/v1/currencies/{code}	Update existing currency.
CurrencyExchangeRatesApi	GetExchangeRate	GET /api/v1/cer	Get an exchange rate.
ImportApi	GetImport	GET /api/v1/import/{key}	Show info on a single import
ImportApi	ListImport	GET /api/v1/import/list	List al imports
ImportApi	ListTransactionByImport	GET /api/v1/import/{key}/transactions	List all transactions related to the import job. The correlation is made through the tag.
LinksApi	DeleteLinkType	DELETE /api/v1/link_types/{id}	Permanently delete link type.
LinksApi	DeleteTransactionLink	DELETE /api/v1/transaction_links/{id}	Permanently delete link between transactions.
LinksApi	GetLinkType	GET /api/v1/link_types/{id}	Get single a link type.
LinksApi	GetTransactionLink	GET /api/v1/transaction_links/{id}	Get a single link.
LinksApi	ListLinkType	GET /api/v1/link_types	List all types of links.
LinksApi	ListTransactionByLinkType	GET /api/v1/link_types/{id}/transactions	List all transactions under this link type.
LinksApi	ListTransactionLink	GET /api/v1/transaction_links	List all transaction links.
LinksApi	StoreLinkType	POST /api/v1/link_types	Create a new link type
LinksApi	StoreTransactionLink	POST /api/v1/transaction_links	Create a new link between transactions
LinksApi	UpdateLinkType	PUT /api/v1/link_types/{id}	Update existing link type.
LinksApi	UpdateTransactionLink	PUT /api/v1/transaction_links/{id}	Update an existing link between transactions.
PiggyBanksApi	DeletePiggyBank	DELETE /api/v1/piggy_banks/{id}	Delete a piggy bank.
PiggyBanksApi	GetPiggyBank	GET /api/v1/piggy_banks/{id}	Get a single piggy bank.
PiggyBanksApi	ListEventByPiggyBank	GET /api/v1/piggy_banks/{id}/events	List all events linked to a piggy bank.
PiggyBanksApi	ListPiggyBank	GET /api/v1/piggy_banks	List all piggy banks.
PiggyBanksApi	StorePiggyBank	POST /api/v1/piggy_banks	Store a new piggy bank
PiggyBanksApi	UpdatePiggyBank	PUT /api/v1/piggy_banks/{id}	Update existing piggy bank.
PreferencesApi	GetPreference	GET /api/v1/preferences/{name}	Return a single preference.
PreferencesApi	ListPreference	GET /api/v1/preferences	List all users preferences.
PreferencesApi	UpdatePreference	PUT /api/v1/preferences/{name}	Update preference
RecurrencesApi	DeleteRecurrence	DELETE /api/v1/recurrences/{id}	Delete a recurring transaction.
RecurrencesApi	GetRecurrence	GET /api/v1/recurrences/{id}	Get a single recurring transaction.
RecurrencesApi	ListRecurrence	GET /api/v1/recurrences	List all recurring transactions.
RecurrencesApi	ListTransactionByRecurrence	GET /api/v1/recurrences/{id}/transactions	List all transactions created by a recurring transaction.
RecurrencesApi	StoreRecurrence	POST /api/v1/recurrences	Store a new recurring transaction
RecurrencesApi	TriggerRecurrence	POST /api/v1/recurrences/trigger	Trigger the creation of recurring transactions (like a cron job).
RecurrencesApi	UpdateRecurrence	PUT /api/v1/recurrences/{id}	Update existing recurring transaction.
RuleGroupsApi	DeleteRuleGroup	DELETE /api/v1/rule_groups/{id}	Delete a rule group.
RuleGroupsApi	FireRuleGroup	POST /api/v1/rule_groups/{id}/trigger	Fire the rule group on your transactions.
RuleGroupsApi	GetRuleGroup	GET /api/v1/rule_groups/{id}	Get a single rule group.
RuleGroupsApi	ListRuleByGroup	GET /api/v1/rule_groups/{id}/rules	List rules in this rule group.
RuleGroupsApi	ListRuleGroup	GET /api/v1/rule_groups	List all rule groups.
RuleGroupsApi	StoreRuleGroup	POST /api/v1/rule_groups	Store a new rule group.
RuleGroupsApi	TestRuleGroup	GET /api/v1/rule_groups/{id}/test	Test which transactions would be hit by the rule group. No changes will be made.
RuleGroupsApi	UpdateRuleGroup	PUT /api/v1/rule_groups/{id}	Update existing rule group.
RulesApi	DeleteRule	DELETE /api/v1/rules/{id}	Delete an rule.
RulesApi	FireRule	POST /api/v1/rules/{id}/trigger	Fire the rule on your transactions.
RulesApi	GetRule	GET /api/v1/rules/{id}	Get a single rule.
RulesApi	ListRule	GET /api/v1/rules	List all rules.
RulesApi	StoreRule	POST /api/v1/rules	Store a new rule
RulesApi	TestRule	GET /api/v1/rules/{id}/test	Test which transactions would be hit by the rule. No changes will be made.
RulesApi	UpdateRule	PUT /api/v1/rules/{id}	Update existing rule.
SummaryApi	GetBasicSummary	GET /api/v1/summary/basic	Returns basic sums of the users data.
TagsApi	DeleteTag	DELETE /api/v1/tags/{tag}	Delete an tag.
TagsApi	GetTag	GET /api/v1/tags/{tag}	Get a single tag.
TagsApi	GetTagCloud	GET /api/v1/tag-cloud	Returns a basic tag cloud.
TagsApi	ListTag	GET /api/v1/tags	List all tags.
TagsApi	ListTransactionByTag	GET /api/v1/tags/{tag}/transactions	List all transactions with this tag.
TagsApi	StoreTag	POST /api/v1/tags	Store a new tag
TagsApi	UpdateTag	PUT /api/v1/tags/{tag}	Update existing tag.
TransactionsApi	DeleteTransaction	DELETE /api/v1/transactions/{id}	Delete a transaction.
TransactionsApi	GetTransaction	GET /api/v1/transactions/{id}	Get a single transaction.
TransactionsApi	GetTransactionByJournal	GET /api/v1/transaction-journals/{id}	Get a single transaction, based on one of the underlying transaction journals.
TransactionsApi	ListAttachmentByTransaction	GET /api/v1/transactions/{id}/attachments	Lists all attachments.
TransactionsApi	ListEventByTransaction	GET /api/v1/transactions/{id}/piggy_bank_events	Lists all piggy bank events.
TransactionsApi	ListTransaction	GET /api/v1/transactions	List all the user's transactions.
TransactionsApi	StoreTransaction	POST /api/v1/transactions	Store a new transaction
TransactionsApi	UpdateTransaction	PUT /api/v1/transactions/{id}	Update existing transaction.
UsersApi	DeleteUser	DELETE /api/v1/users/{id}	Delete a user.
UsersApi	GetUser	GET /api/v1/users/{id}	Get a single user.
UsersApi	ListUser	GET /api/v1/users	List all users.
UsersApi	StoreUser	POST /api/v1/users	Store a new user
UsersApi	UpdateUser	PUT /api/v1/users/{id}	Update an existing user's information.

Documentation for Models

• Model.Account
• Model.AccountArray
• Model.AccountRead
• Model.AccountSingle
• Model.AccountTypeFilter
• Model.AccountTypeProperty
• Model.Attachment
• Model.AttachmentArray
• Model.AttachmentRead
• Model.AttachmentSingle
• Model.AvailableBudget
• Model.AvailableBudgetArray
• Model.AvailableBudgetRead
• Model.AvailableBudgetSingle
• Model.BasicSummaryEntry
• Model.Bill
• Model.BillArray
• Model.BillPaidDates
• Model.BillRead
• Model.BillSingle
• Model.Budget
• Model.BudgetArray
• Model.BudgetLimit
• Model.BudgetLimitArray
• Model.BudgetLimitRead
• Model.BudgetLimitSingle
• Model.BudgetRead
• Model.BudgetSingle
• Model.BudgetSpent
• Model.Category
• Model.CategoryArray
• Model.CategoryEarned
• Model.CategoryRead
• Model.CategorySingle
• Model.CategorySpent
• Model.ChartDataPoint
• Model.ChartDataSet
• Model.ConfigurationUpdate
• Model.Currency
• Model.CurrencyArray
• Model.CurrencyRead
• Model.CurrencySingle
• Model.ExchangeRate
• Model.ExchangeRateArray
• Model.ExchangeRateAttributes
• Model.ImportJob
• Model.ImportJobArray
• Model.ImportJobAttributes
• Model.ImportJobSingle
• Model.LinkType
• Model.LinkTypeArray
• Model.LinkTypeRead
• Model.LinkTypeSingle
• Model.Meta
• Model.MetaPagination
• Model.ObjectLink
• Model.ObjectLink0
• Model.PageLink
• Model.PiggyBank
• Model.PiggyBankArray
• Model.PiggyBankEvent
• Model.PiggyBankEventArray
• Model.PiggyBankEventAttributes
• Model.PiggyBankRead
• Model.PiggyBankSingle
• Model.Preference
• Model.PreferenceArray
• Model.PreferenceRead
• Model.PreferenceSingle
• Model.Recurrence
• Model.RecurrenceArray
• Model.RecurrenceRead
• Model.RecurrenceRepetition
• Model.RecurrenceSingle
• Model.RecurrenceTransaction
• Model.Rule
• Model.RuleAction
• Model.RuleArray
• Model.RuleGroup
• Model.RuleGroupArray
• Model.RuleGroupRead
• Model.RuleGroupSingle
• Model.RuleRead
• Model.RuleSingle
• Model.RuleTrigger
• Model.SystemConfiguration
• Model.SystemConfigurationData
• Model.SystemInfo
• Model.SystemInfoData
• Model.TagArray
• Model.TagCloud
• Model.TagCloudTag
• Model.TagModel
• Model.TagRead
• Model.TagSingle
• Model.Transaction
• Model.TransactionArray
• Model.TransactionLink
• Model.TransactionLinkArray
• Model.TransactionLinkRead
• Model.TransactionLinkSingle
• Model.TransactionRead
• Model.TransactionSingle
• Model.TransactionSplit
• Model.TransactionTypeFilter
• Model.User
• Model.UserArray
• Model.UserRead
• Model.UserSingle
• Model.ValidationError
• Model.ValidationErrorErrors

Documentation for Authorization

firefly_iii_auth

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://demo.firefly-iii.org/oauth/authorize
• Scopes: N/A