vzaccaria/hledger-mutuo

hledger-mutuo

Compute french-style mortgage payment interest rates
Explore the docs »

View Demo · Report Bug · Request Feature

About The Project

Just as hledger-interest, computes interests associated with a french-style fixed-rate mortgage (one of the most used schemes in Italy).

Built With

Hledger-lib

Getting Started

To get a local copy up and running follow these simple steps.

Installation

Clone the repo

git clone https://github.com/vzaccaria/hledger-mutuo.git

Install it with stack
```
stack install .
```

Usage

Assume you have the following ledger file (test.ledger):

2019-04-17 Mortgage start
    assets:banca          EUR1000
    liabilities:mutuo    

2019-04-01 Mortgage payment 
    assets:banca            EUR-5.06
    liabilities:mutuo       

2019-05-04 Mortgage payment 
    assets:banca:popso      EUR-5.06
    liabilities:mutuo

To compute the interest associated with the rates (2% annual rate over 20 years) run:

hledger-mutuo -f ./test.ledger -s expenses:mutuo -t liabilities:mutuo liabilities:mutuo -a 0.02 -m 240

to produce the following transactions:

2020-04-01 Mortgage payment interest n.  1 (capital = 3.39)
    liabilities:mutuo        EUR-1.67
    expenses:mutuo            EUR1.67

2020-05-04 Mortgage payment interest n.  2 (capital = 3.40)
    liabilities:mutuo        EUR-1.66
    expenses:mutuo            EUR1.66

Note that with the french scheme you'll pay most of the interest upfront.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Vittorio Zaccaria - @vzaccaria - vittorio.zaccaria@gmail.com

Project Link: https://github.com/vzaccaria/hledger-mutuo

Acknowledgements

You?

vzaccaria / hledger-mutuo