HAX.Assets

This module provides a collection of accounting actions for different asset/account types implemented via the Asset class.

Use these actions to build more complex accounting actions for Entitys from Accounting.

They are implemented using the more basic combinators from Bookkeeping.

Many assets make use the InterestRates defined below.

The Asset class

class Asset a where

An asset is anything that can be handled within an accounting action.

Minimal complete definition

handle

Methods

handle :: a -> AccountingRW s ()

derives the action corresponding to the asset's characteristics

Instances

Asset FixedPayment

Methods

handle :: FixedPayment -> AccountingRW s ()

Asset Liquidity

Methods

handle :: Liquidity -> AccountingRW s ()

Asset Loan

Methods

handle :: Loan -> AccountingRW s ()

Asset TransactionalAccount

Methods

handle :: TransactionalAccount -> AccountingRW s ()

Transactional Account with asymmetric interest rates.

data TransactionalAccount

This assets calculates interest according to its average positive and negative account balances over the last time period and debits it againt the InterestRates iSource accounts.

Other names: Revolving credit, line of credit, Kontokorrent

Constructors

TransactionalAccount

Fields

• taCredit :: InterestRate

  credit interest for negative balances for one period (not neccessarily p.a.)

• taDebit :: InterestRate

  debit interest for positive balances for one period (not neccessarily p.a.)

• taAcc :: AccountName

  asset's account name

• taPeriod :: ASpan

  period in months

Instances

Asset TransactionalAccount

Methods

handle :: TransactionalAccount -> AccountingRW s ()

Loan with fixed (annuity) or variable payments

data PaymentType

Select a payment schedule

Constructors

Linear Decimal

Decreasing payments with fixed repay and decreasing interest portions.

The number specifies the repay as a fraction of the principal amount.

Annuity Decimal

Fixed payments with decreasing interest and increasing repay portions.

The number specifies the initial repay as a fraction of the principal amount.

Instances

Show PaymentType

Methods

showsPrec :: Int -> PaymentType -> ShowS

show :: PaymentType -> String

showList :: [PaymentType] -> ShowS

data Loan

Constructors

Loan

Fields

• lPrincipal :: Amount

  Principal amount payed to lPaymentAccount

• lPType :: PaymentType
• lPaymentAcc :: AccountName

  account for the payments

• lLoanAcc :: AccountName

  account for the open balance

• lInterest :: InterestRate

  interest rate for one period (not neccessarily p.a.)

• lStart :: ADate

  payout date

• lPeriod :: ASpan

  period of the interest payments

Instances

Asset Loan

Methods

handle :: Loan -> AccountingRW s ()

Liquitidy Simulation

data Liquidity

This Asset produces a list of twelve payments, one for each month, that are shifted in such a way, that they sum up to zero

Constructors

Liquidity

Fields

• lFrom :: AccountName
• lTo :: AccountName
• lPayments :: [Amount]

Instances

Asset Liquidity

Methods

handle :: Liquidity -> AccountingRW s ()

Helpers

duration :: PaymentType -> InterestRate -> Decimal

Calculate the number of periods time until the loan is completely repaid.

annuity

Arguments

:: Decimal

number of periods

-> Decimal

interest rate

-> Amount

Calculate the annuity (as a fraction of the principal) for a given number of periods interest rate.

Fixed Payments

data FixedPayment

Recurring Fixed Payment

Constructors

FixedPayment

Fields

• fPayment :: Amount
• fStart :: ADate
• fOffset :: ADate
• fPeriod :: ASpan
• fSource :: AccountName
• fSink :: AccountName
• fComment :: Comment

Instances

Asset FixedPayment

Methods

handle :: FixedPayment -> AccountingRW s ()

Interest Rates

data InterestRate

Interest rates together with the nominal account, the could be identified with the source (for incoming interest payments) or sink (for outgoing, i.e. negative interest payments).

For example, if the interest is an expense, iSource could be "Expenses". If the interest is capital yield, iSource could be "Income".

Constructors

IR

Fields

• iRate :: Amount
• iSource :: AccountName

  this can be something like "Earnings" if the interest can be considered earnings or another entity, if

interest :: InterestRate -> Amount -> Amount

Calculate the interest for a given amount

currentInterest :: (Monoid w, Ledger l) => InterestRate -> AccountName -> AmountA s l w

Calculate the interest for a current balance of an account

interestTx

Arguments

:: InterestRate

-> String

comment

-> AccountName

Sink account

-> Maybe (AmountRW s)

optional: Use this amount instead of the balance of the sink account

-> AmountRW s

Calculate and transfer the interest from the iSource account to some other account.