HAX.Bookkeeping

This module contains the accounting combinators that can be used to build complex accounting actions.

All combinators are guaranteed to only allow balanced transactions that adhere to the double-entry bookkeeping standards.

The module Accounting contains the functions to run these actions and calculate the resulting ledger.

Transactions

tx :: BalancingTx -> AccountingRW s ()

Applies a balanced transaction to the ledger at the current date.

closingTx :: [AccountName] -> BalancingTx -> AccountingRW s ()

as tx but taking a list of accounts that should be emptied completely

type Transfer s = String -> AccountName -> AccountName -> AccountingRW s ()

Type for simple transfers between two accounts

fromTo :: Amount -> Transfer s

Apply a simple transaction

fromToLimit :: Amount -> Transfer s

Apply a simple transaction, but ensure, that source does not change sign

transferAll :: Transfer s

Transfer all funds from one account to the other

Balances

currentBalance :: AccPair l w => AccountName -> Acc s l w Amount

Get the current balance of an account

soll :: AccPair l w => AccountName -> Acc s l w Amount

Get the balance of a Soll account (uses the amounts directly as stored in the ledger)

haben :: AccPair l w => AccountName -> Acc s l w Amount

Get the balance of a Haben Account account (negates the internally stored amounts)

balanceAt :: AccPair l w => ADate -> AccountName -> Acc s l w Amount

Get the balance at a certain date

balancesSince :: AccPair l w => ADate -> AccountName -> Acc s l w [Amount]

Get the balances since a certain date

Date combinators

curDate :: Monoid w => Acc s l w ADate

Get the current date

onceAt :: Monoid w => ADate -> Acc s l w () -> Acc s l w ()

Restrict an accounting action to a certain date

onceEvery

Arguments

:: Monoid w

=> ASpan

Period

-> ADate

Offset

-> Acc s l w a

-> Acc s l w ()

Execute an action periodically

atYearEnd :: Monoid w => Acc s l w a -> Acc s l w ()

Execute an action at the end of every year

onlyAfter :: Monoid w => ADate -> Acc s l w a -> Acc s l w ()

Executes an action only after a certain date

schedule :: Monoid w => ADate -> Acc s l w a -> Acc s l w a

Perform an accounting action now, but run it with a modified (future) date. E.g.

schedule (date 12 2016) $ tx1

All changes that tx1 performs will be written to the ledger right now, but only modify balances at 12/2016.

Logging

logMsg

Arguments

:: Bool

True = to stdout, False = to ledger

-> String

-> AccountingRW s ()

Write a log entry to stdout or to the ledger

logLedger :: String -> AccountingRW s ()

Write a log entry to the ledger

singleLog

Arguments

:: PrintfArg t

=> String

formatting string

-> t

value

-> AccountingReadOnly body ()

within the ReadOnly Monad: register a single log entry consisting of a formating string and a value

singleResult

Arguments

:: (PrintfArg a, Num a, Eq a)

=> String

formatting string

-> AccountingReadOnly body a

action

-> AccountingReadOnly body a

within the ReadOnly Monad: return the value of an action and register a single log entry describing the value, but only if it s not zero