API Documentation¶
Note
There’s no stability guarantee as this is just for internal purposes currently.
- fava
- fava.application
- fava.cli
- fava.context
- fava.helpers
- fava.internal_api
ChartApi
ChartData
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
Context
QueryResult
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
- fava.template_filters
- 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
Filters
- fava.core._compat
- fava.core.accounts
- fava.core.attributes
- fava.core.budgets
- fava.core.charts
- fava.core.commodities
- fava.core.conversion
- fava.core.documents
- fava.core.entries_by_type
- fava.core.extensions
- 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
- fava.core.filters
AccountFilter
AdvancedFilter
EntryFilter
FilterException
FilterSyntaxLexer
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
TimeFilter
Token
- fava.core.ingest
- fava.core.inventory
- fava.core.misc
- fava.core.module_base
- fava.core.number
- fava.core.query_shell
- fava.core.tree
- fava.core.watcher
- fava.ext
- fava.ext.portfolio_list
- fava.help
- fava.plugins
- fava.util
filter_api_changed()
listify()
next_key()
pairwise()
resource_path()
send_file_inline()
setup_logging()
simple_wsgi()
slugify()
timefunc()
- fava.util.date
- fava.util.excel
- fava.util.ranking
- fava.util.sets
- fava.util.typing