From 4c863ea4d74edb9e18a400b15324c41003ad6758 Mon Sep 17 00:00:00 2001 From: Ben Sturmfels Date: Thu, 22 Feb 2024 14:29:50 +1100 Subject: [PATCH] Update docs to explain how to test output with Beancount --- README.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1a86921..aa74a09 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,26 @@ intricate Beancount bookkeeping data. Run with: - java -jar import-0.0.8-standalone.jar --csv 2023-12-27_Pay-Item-Details_2023-12-2.csv --date 2023-12-29 --period 'December 2023' --total-fees 206.50 --pay-receipt-no rt:19462/674660 --pay-invoice-no rt:19403/675431 --fees-receipt-no rt:19459/675387 --fees-invoice-no rt:19459/674887 --retirement-receipt-no rt:19403/676724 --retirement-invoice-no rt:19403/675431 + java -jar import-0.0.8-standalone.jar --csv resources/example-paychex-pay-item-details.csv --date 2023-12-29 --period 'December 2023' --total-fees 206.50 --pay-receipt-no rt:19462/674660 --pay-invoice-no rt:19403/675431 --fees-receipt-no rt:19459/675387 --fees-invoice-no rt:19459/674887 --retirement-receipt-no rt:19403/676724 --retirement-invoice-no rt:19403/675431 Or use a reduced set of options (missing values will be replaced by "TODO" in the output): - java -jar import-0.0.8-standalone.jar --csv 2023-12-27_Pay-Item-Details_2023-12-2.csv --date 2023-12-29 --period "December 2023" --total-fees 206.50 + java -jar import-0.0.8-standalone.jar --csv resources/example-paychex-pay-item-details.csv --date 2023-12-29 --period "December 2023" --total-fees 206.50 + +You can test the output in Beancount by adding the following header entries to define the accounts: + + 2023-01-01 open Assets:FR:Check2721 + 2023-01-01 open Assets:FR:Check1345 + 2023-01-01 open Expenses:Payroll:Salary + 2023-01-01 open Expenses:Payroll:Fees + 2023-01-01 open Expenses:Payroll:Tax + 2023-01-01 open Expenses:Hosting + 2023-01-01 open Expenses:Insurance + 2023-01-01 open Liabilities:Payable:Accounts + +Then run Beancount with: + + bean-report [your file] balances ## Development @@ -26,7 +41,7 @@ Run tests with: You can run without building using: - clojure -M -m core --csv 2023-12-27_Pay-Item-Details_2023-12-2.csv --date 2023-12-29 --period "December 2023" --total-fees 206.50 + clojure -M -m core --csv resources/example-paychex-pay-item-details.csv --date 2023-12-29 --period "December 2023" --total-fees 206.50 ## Build