Following A Budget using Account Codes, Easy and Accessible to Everyone! Fabaceae is also the latin name for the Bean family of plants (shout-out to Beancount).
This project aims to simplify the process of extracting data from your bank and using it with your Plain Text Accounting (PTA) engine of choice. These tools help you analyse your data and create reports, but the process of adding that data can be tedious. Just tell Fabaceae where to find your accounts and how your bank statement is structured and from that day you can drag and drop your bank statements and it will be ready for analysis in no time!
I wanted to create a tool using the beautiful library Spectre.Console that could help me quickly translate my bank statements to .journal files, and this is the result. I am glad that you found your way here, and I hope that it will help you too!
If you are new to PTA, you can read more at https://plaintextaccounting.org.
- Read bank statements from
.xlsxfiles. - Load your accounts from
.ledgerfiles. - Interactively match accounts with your transactions.
- Output the results to a
.ledgerfile.
Also:
- Persistent config - set it up once, save time later.
- Save formats of different bank statements for easy reuse.
You need a file containing the accounts you use in your accounting. Supply a file name to the CLI using the add accounts <path> command and it will save it for later, or you can supply it at runtime using the -a <path> option. The account plan is assumed to be either in the same folder as the bank statement or the current working directory and will search for it in that order.
The account hierarchy is determined via : as shown in the example below:
account Assets:Bank
account Income:Salary
account Liabilities:CreditCard
account Expenses:Food
account Expenses:Rent
account Expenses:Utilities
account Expenses:Leisure
account Expenses:Other
You are free to set this up however you like, with the exception that you need to use at least two levels of hierarchy.
In order to properly read your bank statement you need to add it to the configuration using the add reader <name> command. You will be prompted for the different values requrired, or you can supply them via options (use add reader -h for details). The config will be saved under the supplied name so that you can easily use it again.
Just supply your bank statement path as parameter and you are good to go! This also means that you can drag-and-drop the bank statement onto the executable if you are so inclined (only one at a time though).
Optionally you can supply the name of the reader you wish to use via the -r <reader> option, otherwise you will be prompted. Use -h for details.
To build and run it from source you need the .NET 7 SDK.
To build and run, execute the following commands in the /src directory.
dotnet build
dotnet run -- -h
If you want to deploy and use it standalone (on windows):
dotnet publish --output=out --configuration=Release --runtime=win-x64 --self-contained -p:PublishSingleFile=true
If you use VSCode and have Docker installed you can skip installing the SDK and instead set up a Development Container using the extension ms-vscode-remote.remote-containers. Simply install the extension and clone the repository and you will be asked if you wish to open the repository in a container using the provided configuration.
There are VSCode tasks set up for build and publish that you can use.
There will be binaries available for those who just want to use the tool.
Obviously.
Reading account definitions from Beancount, for example.