API Documentation¶
Note
There’s no stability guarantee as this is just for internal purposes currently.
- fava
- fava._ctx_globals_class
- fava.application
- fava.cli
- fava.context
- fava.helpers
- fava.internal_api
BalancesChartBarChartChartApiHierarchyChartLedgerDataLedgerData.account_detailsLedgerData.accountsLedgerData.base_urlLedgerData.currenciesLedgerData.currency_namesLedgerData.errorsLedgerData.extensionsLedgerData.fava_optionsLedgerData.have_excelLedgerData.incognitoLedgerData.linksLedgerData.optionsLedgerData.other_ledgersLedgerData.payeesLedgerData.precisionsLedgerData.sidebar_linksLedgerData.tagsLedgerData.upcoming_events_countLedgerData.user_queriesLedgerData.years
SerialisedErrorget_errors()get_ledger_data()
- fava.json_api
AccountBudgetAccountReportJournalAccountReportTreeCommodityPairWithPricesContextDocumentDirectoryMissingErrorFavaJSONAPIErrorFileDoesNotExistErrorIncorrectTypeValidationErrorMissingParameterValidationErrorNoFileUploadedErrorNotAFileErrorNotAValidDocumentOrImportFileErrorOptionsStatisticsTargetPathAlreadyExistsErrorTreeReportUploadedFileIsMissingFilenameErrorValidationErrorapi_endpoint()delete_document()delete_source_slice()get_account_report()get_balance_sheet()get_changed()get_commodities()get_context()get_documents()get_events()get_extract()get_imports()get_income_statement()get_journal()get_move()get_narration_transaction()get_narrations()get_options()get_payee_accounts()get_payee_transaction()get_query()get_source()get_statistics()get_trial_balance()json_err()json_success()put_add_document()put_add_entries()put_attach_document()put_format_source()put_source()put_source_slice()put_upload_import_file()validate_func_arguments()
- fava.serialisation
- fava.template_filters
- fava.beans
- fava.beans.abc
- fava.beans.account
- fava.beans.create
- fava.beans.flags
- fava.beans.funcs
- fava.beans.helpers
- fava.beans.ingest
- fava.beans.load
- fava.beans.prices
- fava.beans.protocols
- fava.beans.str
- fava.beans.types
BeancountOptionsBeancountOptions.account_current_conversionsBeancountOptions.account_current_earningsBeancountOptions.dcontextBeancountOptions.documentsBeancountOptions.filenameBeancountOptions.includeBeancountOptions.name_assetsBeancountOptions.name_equityBeancountOptions.name_expensesBeancountOptions.name_incomeBeancountOptions.name_liabilitiesBeancountOptions.operating_currencyBeancountOptions.render_commasBeancountOptions.title
- fava.core
EntryNotFoundForHashErrorFavaLedgerFavaLedger.account_journal()FavaLedger.accountsFavaLedger.all_entriesFavaLedger.all_entries_by_typeFavaLedger.attributesFavaLedger.beancount_file_pathFavaLedger.budgetsFavaLedger.changed()FavaLedger.chartsFavaLedger.commoditiesFavaLedger.commodity_pairs()FavaLedger.context()FavaLedger.errorsFavaLedger.extensionsFavaLedger.fava_optionsFavaLedger.fava_options_errorsFavaLedger.fileFavaLedger.format_decimalFavaLedger.get_entry()FavaLedger.get_filteredFavaLedger.group_entries_by_type()FavaLedger.ingestFavaLedger.interval_balances()FavaLedger.join_path()FavaLedger.load_errorsFavaLedger.load_file()FavaLedger.miscFavaLedger.mtimeFavaLedger.optionsFavaLedger.paths_to_watch()FavaLedger.pricesFavaLedger.query_shellFavaLedger.root_accountsFavaLedger.statement_path()FavaLedger.watcher
FilteredLedgerFilteredLedger.account_is_closed()FilteredLedger.date_rangeFilteredLedger.end_dateFilteredLedger.entriesFilteredLedger.entries_with_all_pricesFilteredLedger.interval_ranges()FilteredLedger.ledgerFilteredLedger.paginate_journal()FilteredLedger.prices()FilteredLedger.root_treeFilteredLedger.root_tree_closed
StatementMetadataInvalidErrorStatementNotFoundError- fava.core.accounts
- fava.core.attributes
- fava.core.budgets
- fava.core.charts
- fava.core.commodities
- fava.core.conversion
- fava.core.documents
- fava.core.extensions
ExtensionDetailsExtensionModuleExtensionModule.after_delete_entry()ExtensionModule.after_entry_modified()ExtensionModule.after_insert_entry()ExtensionModule.after_insert_metadata()ExtensionModule.after_load_file()ExtensionModule.after_write_source()ExtensionModule.before_request()ExtensionModule.extension_detailsExtensionModule.get_extension()ExtensionModule.load_file()
- fava.core.fava_options
FavaOptionsFavaOptions.account_journal_include_childrenFavaOptions.auto_reloadFavaOptions.collapse_patternFavaOptions.conversion_currenciesFavaOptions.currency_columnFavaOptions.default_fileFavaOptions.default_pageFavaOptions.fiscal_year_endFavaOptions.import_configFavaOptions.import_dirsFavaOptions.indentFavaOptions.insert_entryFavaOptions.invert_gains_losses_colorsFavaOptions.invert_income_liabilities_equityFavaOptions.languageFavaOptions.localeFavaOptions.set_collapse_pattern()FavaOptions.set_default_file()FavaOptions.set_fiscal_year_end()FavaOptions.set_insert_entry()FavaOptions.set_language()FavaOptions.set_locale()FavaOptions.show_accounts_with_zero_balanceFavaOptions.show_accounts_with_zero_transactionsFavaOptions.show_closed_accountsFavaOptions.sidebar_show_queriesFavaOptions.unrealizedFavaOptions.upcoming_eventsFavaOptions.uptodate_indicator_grey_lookback_daysFavaOptions.use_external_editor
InsertEntryOptionInvalidFiscalYearEndOptionErrorMissingOptionErrorNotARegularExpressionErrorNotAStringOptionErrorOptionErrorUnknownLocaleOptionErrorUnknownOptionErrorUnsupportedLanguageOptionErrorparse_option_custom_entry()parse_options()
- fava.core.file
- fava.core.filters
AccountFilterAdvancedFilterEntryFilterFilterErrorFilterIllegalCharErrorFilterParseErrorFilterSyntaxLexerFilterSyntaxLexer.ALL()FilterSyntaxLexer.ANY()FilterSyntaxLexer.CMP_OP()FilterSyntaxLexer.EQ_OP()FilterSyntaxLexer.KEY()FilterSyntaxLexer.LINK()FilterSyntaxLexer.NUMBER()FilterSyntaxLexer.RULESFilterSyntaxLexer.STRING()FilterSyntaxLexer.TAG()FilterSyntaxLexer.lex()FilterSyntaxLexer.regexFilterSyntaxLexer.tokens
FilterSyntaxParserFilterSyntaxParser.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.p_simple_expr_units()FilterSyntaxParser.precedenceFilterSyntaxParser.tokens
MatchMatchAmountTimeFilterTimeFilterParseErrorToken
- fava.core.group_entries
- fava.core.ingest
FileImportInfoFileImportersImportConfigLoadErrorImporterExtractErrorImporterInvalidTypeErrorImporterMethodCallErrorIngestErrorIngestModuleMissingImporterConfigErrorMissingImporterDirsErrorWrappedImporterextract_from_file()filepath_in_primary_imports_folder()find_imports()get_cached_file()load_import_config()walk_dir()
- fava.core.inventory
- fava.core.misc
- fava.core.module_base
- fava.core.number
- fava.core.query
- fava.core.query_shell
- fava.core.tree
- fava.core.watcher
- fava.ext
ExtensionConfigErrorFavaExtensionBaseFavaExtensionBase.after_delete_entry()FavaExtensionBase.after_entry_modified()FavaExtensionBase.after_insert_entry()FavaExtensionBase.after_insert_metadata()FavaExtensionBase.after_load_file()FavaExtensionBase.after_write_source()FavaExtensionBase.before_request()FavaExtensionBase.configFavaExtensionBase.endpointsFavaExtensionBase.extension_dirFavaExtensionBase.has_js_moduleFavaExtensionBase.jinja_envFavaExtensionBase.nameFavaExtensionBase.report_title
FavaExtensionErrorJinjaLoaderMissingErrorextension_endpoint()find_extensions()- fava.ext.auto_commit
- fava.ext.fava_ext_test
- fava.ext.portfolio_list
- fava.help
- fava.plugins
- fava.util
filter_api_changed()get_translations()listify()next_key()send_file_inline()setup_debug_logging()setup_logging()simple_wsgi()slugify()timefunc()- fava.util.date
- fava.util.excel
- fava.util.ranking
- fava.util.sets
- fava.util.unreachable