Module directive

Module directive 

Source
Expand description

Directive types representing all beancount directives.

Beancount has 12 directive types that can appear in a ledger file:

  • Transaction - The most common directive, recording transfers between accounts
  • Balance - Assert that an account has a specific balance
  • Open - Open an account for use
  • Close - Close an account
  • Commodity - Declare a commodity/currency
  • Pad - Automatically pad an account to match a balance assertion
  • Event - Record a life event
  • Query - Store a named BQL query
  • Note - Add a note to an account
  • Document - Link a document to an account
  • Price - Record a price for a commodity
  • Custom - Custom directive type

Structs§

ArchivedBalance
An archived Balance
ArchivedClose
An archived Close
ArchivedCommodity
An archived Commodity
ArchivedCustom
An archived Custom
ArchivedDocument
An archived Document
ArchivedEvent
An archived Event
ArchivedNote
An archived Note
ArchivedOpen
An archived Open
ArchivedPad
An archived Pad
ArchivedPosting
An archived Posting
ArchivedPrice
An archived Price
ArchivedQuery
An archived Query
ArchivedTransaction
An archived Transaction
Balance
A balance assertion directive.
BalanceResolver
The resolver for an archived Balance
Close
A close account directive.
CloseResolver
The resolver for an archived Close
Commodity
A commodity declaration directive.
CommodityResolver
The resolver for an archived Commodity
Custom
A custom directive.
CustomResolver
The resolver for an archived Custom
Document
A document directive.
DocumentResolver
The resolver for an archived Document
Event
An event directive.
EventResolver
The resolver for an archived Event
Note
A note directive.
NoteResolver
The resolver for an archived Note
Open
An open account directive.
OpenResolver
The resolver for an archived Open
Pad
A pad directive.
PadResolver
The resolver for an archived Pad
Posting
A posting within a transaction.
PostingResolver
The resolver for an archived Posting
Price
A price directive.
PriceResolver
The resolver for an archived Price
Query
A query directive.
QueryResolver
The resolver for an archived Query
Transaction
A transaction directive.
TransactionResolver
The resolver for an archived Transaction

Enums§

ArchivedDirective
An archived Directive
ArchivedMetaValue
An archived MetaValue
ArchivedPriceAnnotation
An archived PriceAnnotation
Directive
All directive types in beancount.
DirectivePriority
Directive ordering priority for sorting.
DirectiveResolver
The resolver for an archived Directive
MetaValue
Metadata value types.
MetaValueResolver
The resolver for an archived MetaValue
PriceAnnotation
Price annotation for a posting (@ or @@).
PriceAnnotationResolver
The resolver for an archived PriceAnnotation

Functions§

sort_directives
Sort directives by date, then by type priority.

Type Aliases§

Metadata
Metadata is a key-value map attached to directives and postings.