API Documentation

Note

There’s no stability guarantee as this is just for internal purposes currently.

• fava
  • fava.application
    • app
    • account()
    • document()
    • download_journal()
    • download_query()
    • extension_report()
    • fava_api_exception()
    • get_locale()
    • help_page()
    • holdings_by()
    • index()
    • jump()
    • ledger_slug()
    • report()
    • statement()
    • static_url()
    • template_context()
    • translations()
    • update_ledger_slugs()
    • url_for()
  • fava.cli
  • fava.context
    • Context
      • Context.beancount_file_slug
      • Context.conversion
      • Context.filtered
      • Context.interval
      • Context.ledger
  • fava.helpers
    • BeancountError
    • FavaAPIException
  • fava.internal_api
    • ChartApi
      • ChartApi.account_balance()
      • ChartApi.hierarchy()
      • ChartApi.interval_totals()
      • ChartApi.net_worth()
    • ChartData
      • ChartData.data
      • ChartData.label
      • ChartData.type
    • LedgerData
      • LedgerData.account_details
      • LedgerData.accounts
      • LedgerData.base_url
      • LedgerData.currencies
      • LedgerData.errors
      • LedgerData.extension_reports
      • LedgerData.fava_options
      • LedgerData.have_excel
      • LedgerData.incognito
      • LedgerData.links
      • LedgerData.options
      • LedgerData.other_ledgers
      • LedgerData.payees
      • LedgerData.precisions
      • LedgerData.sidebar_links
      • LedgerData.tags
      • LedgerData.upcoming_events_count
      • LedgerData.user_queries
      • LedgerData.years
    • get_ledger_data()
  • fava.json_api
    • CommodityPairWithPrices
      • CommodityPairWithPrices.base
      • CommodityPairWithPrices.prices
      • CommodityPairWithPrices.quote
    • Context
      • Context.balances_after
      • Context.balances_before
      • Context.entry
      • Context.sha256sum
      • Context.slice
    • QueryResult
      • QueryResult.chart
      • QueryResult.table
    • ValidationError
    • api_endpoint()
    • delete_document()
    • get_changed()
    • get_commodities()
    • get_context()
    • get_documents()
    • get_errors()
    • get_events()
    • get_extract()
    • get_imports()
    • get_move()
    • get_payee_accounts()
    • get_payee_transaction()
    • get_query_result()
    • get_source()
    • json_err()
    • json_success()
    • put_add_document()
    • put_add_entries()
    • put_attach_document()
    • put_format_source()
    • put_source()
    • put_source_slice()
    • validate_func_arguments()
  • fava.serialisation
    • deserialise()
    • deserialise_posting()
    • serialise()
  • fava.template_filters
    • balance_children()
    • basename()
    • collapse_account()
    • cost_or_value()
    • flag_to_type()
    • format_currency()
    • format_date()
    • format_date_filter()
    • get_or_create()
    • hash_entry()
    • remove_keys()
    • should_show()
• fava.core
  • FavaLedger
    • FavaLedger.account_journal()
    • FavaLedger.account_types
    • FavaLedger.accounts
    • FavaLedger.all_entries
    • FavaLedger.all_entries_by_type
    • FavaLedger.all_root_account
    • FavaLedger.attributes
    • FavaLedger.beancount_file_path
    • FavaLedger.budgets
    • FavaLedger.changed()
    • FavaLedger.charts
    • FavaLedger.commodities
    • FavaLedger.commodity_pairs()
    • FavaLedger.context()
    • FavaLedger.errors
    • FavaLedger.extensions
    • FavaLedger.fava_options
    • FavaLedger.file
    • FavaLedger.format_decimal
    • FavaLedger.get_account_sign()
    • FavaLedger.get_entry()
    • FavaLedger.get_filtered()
    • FavaLedger.group_entries_by_type()
    • FavaLedger.ingest
    • FavaLedger.interval_balances()
    • FavaLedger.join_path()
    • FavaLedger.load_file()
    • FavaLedger.misc
    • FavaLedger.mtime
    • FavaLedger.options
    • FavaLedger.paths_to_watch()
    • FavaLedger.price_map
    • FavaLedger.query_shell
    • FavaLedger.statement_path()
  • FilteredLedger
    • FilteredLedger.account_is_closed()
    • FilteredLedger.end_date
    • FilteredLedger.entries
    • FilteredLedger.filters
    • FilteredLedger.interval_ends()
    • FilteredLedger.ledger
    • FilteredLedger.prices()
    • FilteredLedger.root_account
    • FilteredLedger.root_tree
    • FilteredLedger.root_tree_closed
  • Filters
    • Filters.account
    • Filters.apply()
    • Filters.filter
    • Filters.set()
    • Filters.time
  • fava.core._compat
  • fava.core.accounts
    • AccountData
      • AccountData.balance_string
      • AccountData.close_date
      • AccountData.last_entry
      • AccountData.meta
      • AccountData.uptodate_status
    • AccountDict
      • AccountDict.EMPTY
      • AccountDict.all_balance_directives()
      • AccountDict.load_file()
      • AccountDict.setdefault()
    • LastEntry
      • LastEntry.date
      • LastEntry.entry_hash
    • balance_string()
    • get_entry_accounts()
    • uptodate_status()
  • fava.core.attributes
    • AttributesModule
      • AttributesModule.load_file()
      • AttributesModule.payee_accounts()
      • AttributesModule.payee_transaction()
    • get_active_years()
  • fava.core.budgets
    • Budget
    • BudgetError
    • BudgetModule
      • BudgetModule.calculate()
      • BudgetModule.calculate_children()
      • BudgetModule.load_file()
    • calculate_budget()
    • calculate_budget_children()
    • parse_budgets()
  • fava.core.charts
    • ChartModule
      • ChartModule.can_plot_query()
      • ChartModule.hierarchy()
      • ChartModule.interval_totals()
      • ChartModule.linechart()
      • ChartModule.net_worth()
      • ChartModule.query()
    • DateAndBalance
      • DateAndBalance.balance
      • DateAndBalance.date
    • DateAndBalanceWithBudget
      • DateAndBalanceWithBudget.account_balances
      • DateAndBalanceWithBudget.balance
      • DateAndBalanceWithBudget.budgets
      • DateAndBalanceWithBudget.date
    • FavaJSONEncoder
      • FavaJSONEncoder.default()
    • inv_to_dict()
    • setup_json_for_app()
  • fava.core.commodities
    • CommoditiesModule
      • CommoditiesModule.load_file()
      • CommoditiesModule.name()
  • fava.core.conversion
    • cost()
    • cost_or_value()
    • get_market_value()
    • units()
  • fava.core.documents
    • filepath_in_document_folder()
    • is_document_or_import_file()
  • fava.core.entries_by_type
    • EntriesByType
    • group_entries_by_type()
  • fava.core.extensions
    • ExtensionModule
      • ExtensionModule.after_entry_modified()
      • ExtensionModule.after_insert_entry()
      • ExtensionModule.after_insert_metadata()
      • ExtensionModule.after_write_source()
      • ExtensionModule.exts_for_hook()
      • ExtensionModule.load_file()
      • ExtensionModule.template_and_extension()
    • extension_entries()
  • fava.core.fava_options
    • FavaOptions
      • FavaOptions.account_journal_include_children
      • FavaOptions.auto_reload
      • FavaOptions.collapse_pattern
      • FavaOptions.conversion_currencies
      • FavaOptions.currency_column
      • FavaOptions.default_file
      • FavaOptions.default_page
      • FavaOptions.fiscal_year_end
      • FavaOptions.import_config
      • FavaOptions.import_dirs
      • FavaOptions.indent
      • FavaOptions.insert_entry
      • FavaOptions.invert_income_liabilities_equity
      • FavaOptions.language
      • FavaOptions.locale
      • FavaOptions.show_accounts_with_zero_balance
      • FavaOptions.show_accounts_with_zero_transactions
      • FavaOptions.show_closed_accounts
      • FavaOptions.sidebar_show_queries
      • FavaOptions.unrealized
      • FavaOptions.upcoming_events
      • FavaOptions.uptodate_indicator_grey_lookback_days
      • FavaOptions.use_external_editor
    • InsertEntryOption
    • OptionError
    • parse_option_custom_entry()
    • parse_options()
  • fava.core.file
    • EXCL_FLAGS
    • FileModule
      • FileModule.get_source()
      • FileModule.insert_entries()
      • FileModule.insert_metadata()
      • FileModule.render_entries()
      • FileModule.save_entry_slice()
      • FileModule.set_source()
    • find_entry_lines()
    • find_insert_position()
    • get_entry_slice()
    • incomplete_sortkey()
    • insert_entry()
    • insert_metadata_in_file()
    • save_entry_slice()
    • sha256_str()
  • fava.core.filters
    • AccountFilter
      • AccountFilter.set()
    • AdvancedFilter
      • AdvancedFilter.set()
    • EntryFilter
      • EntryFilter.apply()
      • EntryFilter.set()
    • FilterException
    • FilterSyntaxLexer
      • FilterSyntaxLexer.ALL()
      • FilterSyntaxLexer.ANY()
      • FilterSyntaxLexer.KEY()
      • FilterSyntaxLexer.LINK()
      • FilterSyntaxLexer.RULES
      • FilterSyntaxLexer.STRING()
      • FilterSyntaxLexer.TAG()
      • FilterSyntaxLexer.lex()
      • FilterSyntaxLexer.regex
      • FilterSyntaxLexer.tokens
    • FilterSyntaxParser
      • FilterSyntaxParser.p_error()
      • FilterSyntaxParser.p_expr()
      • FilterSyntaxParser.p_expr_all()
      • FilterSyntaxParser.p_expr_and()
      • FilterSyntaxParser.p_expr_any()
      • FilterSyntaxParser.p_expr_negated()
      • FilterSyntaxParser.p_expr_or()
      • FilterSyntaxParser.p_expr_parentheses()
      • FilterSyntaxParser.p_filter()
      • FilterSyntaxParser.p_simple_expr_LINK()
      • FilterSyntaxParser.p_simple_expr_STRING()
      • FilterSyntaxParser.p_simple_expr_TAG()
      • FilterSyntaxParser.p_simple_expr_key()
      • FilterSyntaxParser.precedence
      • FilterSyntaxParser.tokens
    • Match
      • Match.match
    • TimeFilter
      • TimeFilter.set()
    • Token
      • Token.lexer
      • Token.type
      • Token.value
  • fava.core.ingest
    • FileImportInfo
    • FileImporters
    • IngestError
    • IngestModule
      • IngestModule.extract()
      • IngestModule.import_data()
      • IngestModule.load_file()
      • IngestModule.module_path
    • file_import_info()
  • fava.core.inventory
    • CounterInventory
      • CounterInventory.add()
      • CounterInventory.add_amount()
      • CounterInventory.add_inventory()
      • CounterInventory.add_position()
      • CounterInventory.is_empty()
      • CounterInventory.reduce()
    • SimpleCounterInventory
      • SimpleCounterInventory.add()
      • SimpleCounterInventory.is_empty()
  • fava.core.misc
    • FavaError
    • FavaMisc
      • FavaMisc.load_file()
      • FavaMisc.sidebar_links
      • FavaMisc.upcoming_events
    • align()
    • sidebar_links()
    • upcoming_events()
  • fava.core.module_base
    • FavaModule
      • FavaModule.load_file()
  • fava.core.number
    • DecimalFormatModule
      • DecimalFormatModule.load_file()
    • get_locale_format()
  • fava.core.query_shell
    • QueryShell
      • QueryShell.add_help()
      • QueryShell.do_EOF()
      • QueryShell.do_exit()
      • QueryShell.do_quit()
      • QueryShell.execute_query()
      • QueryShell.get_pager()
      • QueryShell.load_file()
      • QueryShell.noop()
      • QueryShell.on_Reload()
      • QueryShell.on_RunCustom()
      • QueryShell.on_Select()
      • QueryShell.query_to_file()
  • fava.core.tree
    • SerialisedTreeNode
      • SerialisedTreeNode.account
      • SerialisedTreeNode.balance
      • SerialisedTreeNode.balance_children
      • SerialisedTreeNode.children
    • Tree
      • Tree.ancestors()
      • Tree.cap()
      • Tree.get()
      • Tree.insert()
      • Tree.net_profit()
    • TreeNode
      • TreeNode.balance
      • TreeNode.balance_children
      • TreeNode.children
      • TreeNode.has_txns
      • TreeNode.name
      • TreeNode.serialise()
  • fava.core.watcher
    • Watcher
      • Watcher.check()
      • Watcher.last_checked
      • Watcher.update()
• fava.ext
  • FavaExtensionBase
    • FavaExtensionBase.after_entry_modified()
    • FavaExtensionBase.after_insert_entry()
    • FavaExtensionBase.after_insert_metadata()
    • FavaExtensionBase.after_write_source()
    • FavaExtensionBase.config
    • FavaExtensionBase.report_title
  • FavaExtensionError
  • find_extensions()
  • fava.ext.auto_commit
    • AutoCommit
      • AutoCommit.after_entry_modified()
      • AutoCommit.after_insert_entry()
      • AutoCommit.after_insert_metadata()
      • AutoCommit.after_write_source()
• fava.ext.portfolio_list
  • PortfolioList
    • PortfolioList.portfolio_accounts()
    • PortfolioList.report_title
• fava.help
• fava.plugins
  • fava.plugins.link_documents
    • DocumentError
    • link_documents()
  • fava.plugins.tag_discovered_documents
    • tag_discovered_documents()
• fava.util
  • filter_api_changed()
  • listify()
  • next_key()
  • pairwise()
  • resource_path()
  • send_file_inline()
  • setup_logging()
  • simple_wsgi()
  • slugify()
  • timefunc()
  • fava.util.date
    • FiscalYearEnd
    • Interval
      • Interval.DAY
      • Interval.MONTH
      • Interval.QUARTER
      • Interval.WEEK
      • Interval.YEAR
      • Interval.format_date()
      • Interval.format_date_filter()
      • Interval.get()
      • Interval.label
    • days_in_daterange()
    • get_fiscal_period()
    • get_next_interval()
    • interval_ends()
    • month_offset()
    • number_of_days_in_period()
    • parse_date()
    • parse_fye_string()
    • substitute()
  • fava.util.excel
    • to_csv()
    • to_excel()
  • fava.util.ranking
    • ExponentialDecayRanker
      • ExponentialDecayRanker.get()
      • ExponentialDecayRanker.list
      • ExponentialDecayRanker.rate
      • ExponentialDecayRanker.scores
      • ExponentialDecayRanker.sort()
      • ExponentialDecayRanker.update()
  • fava.util.sets
    • add_to_set()
  • fava.util.typing