Ledger to Beancount text-based converter
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
docs
examples
misc
tests
.appveyor.yml
.editorconfig
.gitignore
.travis.yml
AUTHORS
LICENSE
Makefile
README.md
cpanfile
ledger2beancount.yml

README.md

Build Status

ledger2beancount

A script to automatically convert Ledger-based textual ledgers to Beancount ones.

Conversion is based on (concrete) syntax, so that information that are not meaningful for accounting reasons but still valuable (e.g., comments, formatting, etc.) can be preserved.

Please read the manual on how to install, configure and use ledger2beancount. The supported features are documented in the manual, too.

Usage

ledger2beancount accepts input from stdin or from a file and will write the converted data to stdout. You can run ledger2beancount like this:

ledger2beancount test.ledger > test.beancount

Installation

Please see the manual for dependencies and installation instructions.

Features

The majority of ledger features are supported by ledger2beancount. Here is an overview of fully supported, partly supported and unsupported features. Please refer to the manual for more details.

Fully supported

  • Accounts
    • Account declarations (account ...)
    • Conversion of invalid account names
    • Mapping of account names
    • Directive apply account
    • Account aliases (alias)
  • Balance assertions
  • Comments
    • Comments in and outside of transactions
    • Directives comment and test
  • Commodities
    • Commodity declarations (commodity ...)
    • Commodity symbols like $, £ and
    • Commodities placed in front and after the amount
    • Conversion of invalid commodities
    • Mapping of commodities
  • Directives
    • bucket / A
    • include
    • Year / Y
  • Flags
    • State flags (posting flags)
    • Transaction state (transaction flags)
  • Inline math
    • Very simple inline math only
  • Lots
    • Lot dates
    • Lot notes
    • Per unit and total costs and prices
    • Conversion of ledger price to beancount cost
  • Metadata
  • Payees
    • Obtain payee from metadata
    • Split payee into payee and narration
    • Assign payee based on narration
  • Tags
    • Directive apply tag
    • Mapping #tags to ^links

Partly supported

  • Amounts
    • Decimal comma (not supported in beancount)
  • Dates
    • Auxiliary dates (no equivalence in beancount)
    • Effective dates (no equivalence in beancount)
  • Directives
    • payee: skipped (not needed in beancount)
    • tag: skipped (not needed in beancount)
  • Tags and links on posting-level (not supported by beancount)
  • Transaction codes: stored as metadata (no equivalence in beancount)
  • Virtual postings: can be skipped or converted to real postings
  • Virtual posting costs: recognised but skipped (no equivalence in beancount)

Not supported

  • Automated transactions
  • Balance assignments
  • Directives
    • assert
    • C (commodity equivalences)
    • check
    • D
    • define
    • expr
    • N
    • Timeclock (I, i, O, o, b, h)
  • Fixated prices (=$10 and the fixed directive)
  • Periodic transactions

Authors

  • Stefano Zacchiroli <zack@upsilon.cc>
  • Martin Michlmayr <tbm@cyrius.com>

License

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.