API Reference beancount_ex v#0.6.0

Copy Markdown View Source

Modules

Idiomatic Elixir interface to Beancount.

Low-level wrapper around the bean-check command-line tool.

Raised when the configured bean-check executable cannot be located.

Compare two engines on identical input within the v0.4 parity contract.

Beancount cost/lot specification for inventory postings.

Protocol implemented by every Beancount directive struct.

The balance directive asserts an account balance at a date.

The close directive marks an account as inactive.

The commodity directive declares a currency or commodity.

The custom directive is a generic, user-defined directive.

The document directive links a file to an account at a date.

The event directive tracks the value of a named variable over time.

The include directive pulls another ledger file into the current one.

The note directive attaches a dated comment to an account.

The open directive declares the start of an account's life.

The option directive sets file-wide Beancount configuration.

The pad directive inserts an automatic balancing transaction before the next balance assertion on an account.

The plugin directive loads a Beancount plugin module.

The poptag directive pops a tag from Beancount's tag stack.

The price directive records the price of a commodity in another currency.

The pushtag directive pushes a tag onto Beancount's tag stack.

The query directive stores a named BQL query in the ledger.

The transaction directive records a balanced movement between accounts.

Behaviour that every Beancount execution backend must implement.

The default engine: a thin wrapper around the Beancount bean-check and bean-query CLI tools.

Native Elixir engine: parse, render, booking-aware check, and canned reports.

Helpers for golden-file regression testing.

Normalizes raw engine output into a stable, engine-independent structure.

Parse Beancount .bean text into typed directive structs.

Structured parse error for Beancount input.

StreamData generators and helpers for property-based testing.

Structured difference between oracle and native engine results.

Ecto.Query-based queries against stored Beancount directives.

Low-level wrapper around the bean-query command-line tool.

Raised when the configured bean-query executable cannot be located.

Neutral, engine-independent result of a BQL query.

Deterministic rendering of directive streams into Beancount text.

Ecto repository backing Beancount.Storage and Beancount.Queries.

Higher-level reporting API built on top of Beancount.query_text/2.

Normalized result of running a Beancount check.

Ecto schemas for persisting Beancount directives.

Persisted balance assertion (table beancount_balances).

Persisted close directive (table beancount_closes).

Persisted commodity directive (table beancount_commodities).

Persisted cost/lot specification (embedded schema).

Persisted custom directive (table beancount_customs).

Persisted document directive (table beancount_documents).

Persisted event directive (table beancount_events).

Persisted include directive (table beancount_includes).

Persisted note directive (table beancount_notes).

Persisted open directive (table beancount_opens).

Persisted option directive (table beancount_options).

Persisted pad directive (table beancount_pads).

Persisted plugin directive (table beancount_plugins).

Persisted poptag directive (table beancount_pop_tags).

Persisted transaction posting (embedded schema).

Persisted price directive (table beancount_prices).

Persisted posting price annotation (embedded schema).

Persisted pushtag directive (table beancount_push_tags).

Persisted query directive (table beancount_queries).

Persisted transaction directive (table beancount_transactions).

Storage and import/export for Beancount directives via Ecto.

Typed scalar values for Beancount.Directives.Custom and metadata.

An account name for custom directive values.

A commodity amount for custom directive values.

A tag for custom directive values.

Mix Tasks

Regenerate the golden fixtures under test/fixtures/golden/.