The hledger-interest package

[Tags: bsd3, program]

hledger-interest is a small command-line utility based on Simon Michael's hleder library. Its purpose is to compute interest for a given ledger account. Using command line flags, the program can be configured to use various schemes for day-counting, such as act/act, 30/360, 30E/360, and 30/360isda. Furthermore, it supports a (small) number of interest schemes, i.e. annual interest with a fixed rate and the scheme mandated by the German BGB288 (Basiszins fuer Verbrauchergeschaefte). Extending support for other schemes is fairly easy, but currently requires changes to the source code.

As an example, consider the following loan, stored in a file called test.ledger:

 2008/09/26 Loan
     Assets:Bank          EUR 10000.00
     Liabilities:Loan

 2008/11/27 Payment
     Assets:Bank          EUR -3771.12
     Liabilities:Loan

 2009/05/03 Payment
     Assets:Bank          EUR -1200.00
     Liabilities:Loan

 2010/12/10 Payment
     Assets:Bank          EUR -3700.00
     Liabilities:Loan

Suppose that loan earns 5% interest per year, and payments amortize interest before amortizing the principal claim, then the resulting ledger would look like this:

 $ hledger-interest --file=test.ledger --source=Expenses:Interest --target=Liabilities:Loan --30-360 --annual=0.05 Liabilities:Loan
 2008/09/26 Loan
     Assets:Bank              EUR  10000.00
     Liabilities:Loan

 2008/11/27 Payment
     Assets:Bank              EUR  -3771.12
     Liabilities:Loan

 2008/11/27 5.00% interest for EUR -10000.00 over 61 days
     Liabilities:Loan         EUR    -84.72
     Expenses:Interest

 2008/12/31 5.00% interest for EUR -6313.60 over 34 days
     Liabilities:Loan         EUR    -29.81
     Expenses:Interest

 2009/05/03 Payment
     Assets:Bank              EUR  -1200.00
     Liabilities:Loan

 2009/05/03 5.00% interest for EUR -6343.42 over 123 days
     Liabilities:Loan         EUR   -108.37
     Expenses:Interest

 2009/12/31 5.00% interest for EUR -5251.78 over 238 days
     Liabilities:Loan         EUR   -173.60
     Expenses:Interest

 2010/12/10 Payment
     Assets:Bank              EUR  -3700.00
     Liabilities:Loan

 2010/12/10 5.00% interest for EUR -5425.38 over 340 days
     Liabilities:Loan         EUR   -256.20
     Expenses:Interest

 2010/12/31 5.00% interest for EUR -1981.58 over 21 days
     Liabilities:Loan         EUR     -5.78
     Expenses:Interest

Running the utility with --help gives a brief overview over the available options:

 Usage: hledger-interest [OPTION...] ACCOUNT
   -h          --help            print this message and exit
   -V          --version         show version number and exit
   -v          --verbose         echo input ledger to stdout (default)
   -q          --quiet           don't echo input ledger to stdout
               --today           update account until today
   -f FILE     --file=FILE       input ledger file
   -s ACCOUNT  --source=ACCOUNT  interest source account
   -t ACCOUNT  --target=ACCOUNT  interest target account
               --act             use 'act' day counting convention
               --30-360          use '30/360' day counting convention
               --30E-360         use '30E/360' day counting convention
               --30E-360isda     use '30E/360isda' day counting convention
               --constant=RATE   constant interest rate
               --annual=RATE     annual interest rate
               --bgb288          compute interest according to German BGB288

Properties

Versions1.0, 1.1, 1.2, 1.3, 1.4, 1.4.1, 1.4.2, 1.4.3
Dependenciesbase (>=3 && <5), Cabal, hledger-lib (>=0.20), mtl, time
LicenseBSD3
AuthorPeter Simons <simons@cryp.to>
MaintainerPeter Simons <simons@cryp.to>
CategoryFinance
Home pagehttp://github.com/peti/hledger-interest
Source repositoryhead: git clone git://github.com/peti/hledger-interest.git
Executableshledger-interest
Upload dateThu May 2 10:26:08 UTC 2013
Uploaded byPeterSimons
DistributionsDebian:1.4.3, NixOS:1.4.3
Downloads700 total (87 in last 30 days)

Downloads

Maintainers' corner

For package maintainers and hackage trustees