The buchhaltung package
ATTENTION Use `stack build` as this package requires a developement version of hledger! Automatic import and deduplication (from CSV/FinTS/HBCI/OFX), bayesian account matching, and efficient manual entry of ledger transactions.
See Readme on Github.
[Skip to ReadMe]
- buchhaltung-0.0.2.tar.gz [browse] (Cabal source package)
- Package description (included in the package)
For package maintainers and hackage trustees
Readme for buchhaltung-0.0.2
What advantages does he derive from the system of book-keeping by double entry! It is among the finest inventions of the human mind; every prudent master of a house should introduce it into his economy. -- Johann Wolfgang von Goethe
Buchhaltung (['buːχˌhaltʊŋ], German book keeping), written in Haskell, helps you keep track of your finances on the commandline with minimal effort. It provides tools that help you in creating a complete ledger of all your bank and savings accounts', credit cards', and other transactions, in a text-based ledger format, that is readable by the ledger CLI tool and its many derivatives.
- Fetch your bank transaction directly via FinTS/HBCI/OFXDirectConnect
- Import transactions from PayPal (can be customized to other formats)
- Semi-automatically match transactions to accounts using Bayesian classification
- Semi-automatic transaction entry with meaningful suggestions in keyboard-based speed mode
- It is couples/room-mates aware: Create several transaction simultaniuously (see Multi-user add)
Status & aim
I am actively and successfully using this software since 2010 and my ledger now contains more than 12.000 transactions accurately and continuously tracking the finances of my spouse and me including four checking and two savings accounts, one credit card, two paypal accounts, two cash wallets in EUR, bitcoin trading (both physical and on exchanges) and other currencies like USD, GPB used on trips.
The software is in alpha phase and I am looking for early adopters and their use cases. The aim of this stage is to agree about the functionality and customizability and produce a first shipable version, that can be used without tinkering with the source.
Right now, I am using it on Linux but it should also run wherever GHC runs.
Required to compile the software.
AqBanking Command Line Tool (optional)
This is required for direct retrieval of bank transactions via FinTS/HBCI/EBICS (Germany) or OFXDirectConnect (USA, Canada, UK). Packages available e.g. on Ubuntu (aqbanking-tools) and ArchLinux (aqbanking). (AqBanking is also the used by GnuCash for this purpose.)
Bayesian classifier used to match transaction to accounts. Packages available e.g. on Ubuntu and ArchLinux (AUR).
... to query the ledger, create balance and report statements, web interface, etc.
Download, compile & install
# download git clone https://github.com/johannesgerer/buchhaltung.git cd buchhaltung # compile and install (usually in ~/.local/bin) stack install
Create a folder that will hold all your config and possibly ledger files:
mkdir ~/.buchhaltung cp /path/to/buchhaltung/config.yml ~/.buchhaltung/config.yml
If you want a folder under a different location, either create a symlink or set the
BUCHHALTUNGenvironment variable to that location.
Make sure the configured ledger files exist.
config.ymlfile provides excessive comments.
- This readme documents most functionality.
- Every command and subcommand shows a help message when invoked with
- Read the haddock documentation and source code on Hackage.
- Open an issue.
- Write an email.
First usage / clean
To initialize AqBanking after you edited the config file, you need to run:
To clean everythink aqbanking related remove the configured
aqBanking.configDir and rerun the
Manual AqBanking setup
Currently only the
PinTan method is supportend (pull requests welcome). For other methods or if the AqBanking setup fails due to other reasons, you can configure AqBanking manually into the configured
aqBanking.configDir (see for help here or here, usually via
aqhbci-tool4 -C <aqBanking.configDir>).
There various ways (including from PayPal CSV files) to import transactions into your configured
ledgers.imported file. They are presented in the folling, but consult
buchhaltung import -h
-h calls to its subcommands to see the currently available functionality.
The accounts of the imported transactions will be taken from the configured
bankAccounts and the offsetting balaence will be posted to an account named
TODO, and will be replaced by
The original source information will be included in the second posting's comment and used for learning the account mappings and to find and handle duplicates.
This command fetches and imports all available transactions from all configured AqBanking connections.
Banks often minimally change the way they report transactions which leads to unwanted duplicates.
When importing, Buchhaltung will identify duplicates based on
([(Commodity,Quantity)], AccountName, Day) and interactively resolve them by showing the user what fields have changed. If there are several candidates, it sorts the candidates according to similarity using
levenshteinDistance from edit-distance. (See
This command asks the user for the offsetting accounts of imported transactions, or more specifically, transaction whose second posting's account begins with
Have a look at the example output here.
The significantly speed up this process, it learns the account mapping from existing transactions in the configured
ledgers.imported file using the original source of the imported tansaction.
See this information about the account input field.
The Bayesian classifier can only work if similar transactions are always matched with the same account.
Consider frequent credit card payments to Starbucks:
Match them with
Expenses:Food:Starbucksif you know that these should always be booked to that account.
Match them with
Accounts receivable:Starbucksand manually enter your paper receipts if
you want to make sure they charge you the correct amounts.
you sometimes order for friends and get reimbursed later.
This command opens a transaction editor. Here is an example of the output of this command.
The amount of manual typing is kept to a minimum by two clever suggestion mechanisms and TAB completion.
Input and TAB completion
All input fields save their history in the current directory. It can be browsed using up and down arrow keys.
The account input fields support TAB completion. To make this even more useful, the account hierarchy is read in reverse order. For example
Expenses:Food has to be entered as
After the amount is entered, the user can select a transaction whose title, date, amount and second posting's account will used to prefill an offsetting transaction. Suggestions will consist of all transactions
- whose second posting has not been cleared (i.e. marked with an asterisk in front of the account name, and
- whose first posting's amount has the absolute value as the entered amount
- whose first posting's account is contained in the configured
bankAccountsand does not match any of regexes in
Once the first posting's account has been entered, the editor suggests accounts for the second posting based on the frequecy of the resulting transaction's accounts in the configured
Assertions & assignments
In order to be able to enter naked amounts and have the currency added automatically, add a default currency to the configured
addedByThisUser ledger file. Example:
D 1,000.000 EUR
buchhaltung add -w alice
If there is more than one user configured — possibly each with their own ledger, they can be included/activated via the commandline argument
-w. This enables you to enter a transaction where postings belong to different users. When done, a transaction for each user will be generated containing their respective postings and a balancing posting to an account prefixed with the configured
Example taken from the output of the above command:
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2016/12/19 Dinner Account | Amount | Assertion -------------------------+----------+-----------+---------- 0,jo Wallet:Assets | $ -100.0 | | 1,jo Food:Expenses | $ 50 | | 2,alice Food:Expenses | $ 50 | | -------------------------+----------+-----------+---------- Open Balance | 0 |
generates the following transactions
####### jo: Balanced Transaction ####### 2016/12/19 Dinner ; Entered on "2016-12-19T19:01:00Z" by 'buchhaltung' user jo Wallet:Assets $ -100.0 Food:Expenses $ 50 Accounts receivable:Friends:alice:jo $ 50 ####### alice: Balanced Transaction ####### 2016/12/19 Dinner ; Entered on "2016-12-19T19:01:00Z" by 'buchhaltung' user jo Accounts receivable:Friends:jo:jo $ -50 Food:Expenses $ 50
Get current AqBanking account balances
buchhaltung ledger buchhaltung hledger
This calls the respective program with the
LEDGER environment variable set to the configured
Commit the changes
buchhaltung commit -a -m'checking account ok'
this commits all changes to the git repository that contains the
mainLedger file. The commit message will also contain the output of
buchhaltung lb and
buchhaltung ledger balance --end tomorrow.