Copyright	Kadzuya Okamoto 2017
License	MIT
Stability	experimental
Portability	unknown
Safe Haskell	None
Language	Haskell2010

Business.Bookkeeping

Contents

Usage examples
Pritty printers
Constructors
Converters
Types

Description

This module exports core functions and types for bookkeeping.

Synopsis

Usage examples

>>> :{
let
  advance :: CategoryName -> SubDescription -> Amount -> DateTransactions
  advance name = dateTrans
    (DebitCategory $ Category name Expenses)
    (CreditCategory $ Category "Deposit" Assets)
  sample =
    year 2015 $ do
      month 1 $ do
        activity 1 "Constant expenses" $
          advance "Communication" "Mobile phone" 3000
        activity 3 "Mail a contract" $ do
          advance "Communication" "Stamp" 50
          advance "Office supplies" "Envelope" 100
      month 2 $
        activity 1 "Constant expenses" $
          advance "Communication" "Mobile phone" 3000
:}

Pritty printers

ppr :: Transactions -> IO () #

A pretty printer for Transactions.

>>> ppr sample
tDay: 2015-01-01
tDescription: Constant expenses
tSubDescription: Mobile phone
tDebit: Communication (Expenses)
tCredit: Deposit (Assets)
tAmount: 3000

tDay: 2015-01-03
tDescription: Mail a contract
tSubDescription: Stamp
tDebit: Communication (Expenses)
tCredit: Deposit (Assets)
tAmount: 50

tDay: 2015-01-03
tDescription: Mail a contract
tSubDescription: Envelope
tDebit: Office supplies (Expenses)
tCredit: Deposit (Assets)
tAmount: 100

tDay: 2015-02-01
tDescription: Constant expenses
tSubDescription: Mobile phone
tDebit: Communication (Expenses)
tCredit: Deposit (Assets)
tAmount: 3000

Constructors

year :: Year -> YearTransactions -> Transactions #

Convert from YearTransactions to Transactions.

month :: Month -> MonthTransactions -> YearTransactions #

Convert from MonthTransactions to YearTransactions.

activity :: Date -> Description -> DateTransactions -> MonthTransactions #

Convert from DateTransactions to MonthTransactions.

dateTrans :: DebitCategory -> CreditCategory -> SubDescription -> Amount -> DateTransactions #

Converters

runTransactions :: Transactions -> [Transaction] #

Take list of Transaction out from Transactions.

Types

type Transactions = Trans Transaction #

A type for handling Transaction values.

type YearTransactions = Trans (Year -> Transaction) #

type MonthTransactions = Trans (Month -> Year -> Transaction) #

type DateTransactions = Trans (Date -> Description -> Month -> Year -> Transaction) #

data Transaction #

A type representing a transaction.

Constructors

Transaction
Fields tDay :: Day tDescription :: Description tSubDescription :: SubDescription tDebit :: DebitCategory tCredit :: CreditCategory tAmount :: Amount

Instances

Eq Transaction #
Methods (==) :: Transaction -> Transaction -> Bool # (/=) :: Transaction -> Transaction -> Bool #
Ord Transaction #
Methods compare :: Transaction -> Transaction -> Ordering # (<) :: Transaction -> Transaction -> Bool # (<=) :: Transaction -> Transaction -> Bool # (>) :: Transaction -> Transaction -> Bool # (>=) :: Transaction -> Transaction -> Bool # max :: Transaction -> Transaction -> Transaction # min :: Transaction -> Transaction -> Transaction #
Read Transaction #
Methods readsPrec :: Int -> ReadS Transaction # readList :: ReadS [Transaction] # readPrec :: ReadPrec Transaction # readListPrec :: ReadPrec [Transaction] #
Show Transaction #
Methods showsPrec :: Int -> Transaction -> ShowS # show :: Transaction -> String # showList :: [Transaction] -> ShowS #

newtype Year #

Constructors

Year
Fields unYear :: Integer

Instances

Enum Year #
Methods succ :: Year -> Year # pred :: Year -> Year # toEnum :: Int -> Year # fromEnum :: Year -> Int # enumFrom :: Year -> [Year] # enumFromThen :: Year -> Year -> [Year] # enumFromTo :: Year -> Year -> [Year] # enumFromThenTo :: Year -> Year -> Year -> [Year] #
Eq Year #
Methods (==) :: Year -> Year -> Bool # (/=) :: Year -> Year -> Bool #
Num Year #
Methods (+) :: Year -> Year -> Year # (-) :: Year -> Year -> Year # (*) :: Year -> Year -> Year # negate :: Year -> Year # abs :: Year -> Year # signum :: Year -> Year # fromInteger :: Integer -> Year #
Ord Year #
Methods compare :: Year -> Year -> Ordering # (<) :: Year -> Year -> Bool # (<=) :: Year -> Year -> Bool # (>) :: Year -> Year -> Bool # (>=) :: Year -> Year -> Bool # max :: Year -> Year -> Year # min :: Year -> Year -> Year #
Read Year #
Methods readsPrec :: Int -> ReadS Year # readList :: ReadS [Year] # readPrec :: ReadPrec Year # readListPrec :: ReadPrec [Year] #
Show Year #
Methods showsPrec :: Int -> Year -> ShowS # show :: Year -> String # showList :: [Year] -> ShowS #

newtype Month #

Constructors

Month
Fields unMonth :: Int

Instances

Enum Month #
Methods succ :: Month -> Month # pred :: Month -> Month # toEnum :: Int -> Month # fromEnum :: Month -> Int # enumFrom :: Month -> [Month] # enumFromThen :: Month -> Month -> [Month] # enumFromTo :: Month -> Month -> [Month] # enumFromThenTo :: Month -> Month -> Month -> [Month] #
Eq Month #
Methods (==) :: Month -> Month -> Bool # (/=) :: Month -> Month -> Bool #
Num Month #
Methods (+) :: Month -> Month -> Month # (-) :: Month -> Month -> Month # (*) :: Month -> Month -> Month # negate :: Month -> Month # abs :: Month -> Month # signum :: Month -> Month # fromInteger :: Integer -> Month #
Ord Month #
Methods compare :: Month -> Month -> Ordering # (<) :: Month -> Month -> Bool # (<=) :: Month -> Month -> Bool # (>) :: Month -> Month -> Bool # (>=) :: Month -> Month -> Bool # max :: Month -> Month -> Month # min :: Month -> Month -> Month #
Read Month #
Methods readsPrec :: Int -> ReadS Month # readList :: ReadS [Month] # readPrec :: ReadPrec Month # readListPrec :: ReadPrec [Month] #
Show Month #
Methods showsPrec :: Int -> Month -> ShowS # show :: Month -> String # showList :: [Month] -> ShowS #

newtype Date #

Constructors

Date
Fields unDate :: Int

Instances

Enum Date #
Methods succ :: Date -> Date # pred :: Date -> Date # toEnum :: Int -> Date # fromEnum :: Date -> Int # enumFrom :: Date -> [Date] # enumFromThen :: Date -> Date -> [Date] # enumFromTo :: Date -> Date -> [Date] # enumFromThenTo :: Date -> Date -> Date -> [Date] #
Eq Date #
Methods (==) :: Date -> Date -> Bool # (/=) :: Date -> Date -> Bool #
Num Date #
Methods (+) :: Date -> Date -> Date # (-) :: Date -> Date -> Date # (*) :: Date -> Date -> Date # negate :: Date -> Date # abs :: Date -> Date # signum :: Date -> Date # fromInteger :: Integer -> Date #
Ord Date #
Methods compare :: Date -> Date -> Ordering # (<) :: Date -> Date -> Bool # (<=) :: Date -> Date -> Bool # (>) :: Date -> Date -> Bool # (>=) :: Date -> Date -> Bool # max :: Date -> Date -> Date # min :: Date -> Date -> Date #
Read Date #
Methods readsPrec :: Int -> ReadS Date # readList :: ReadS [Date] # readPrec :: ReadPrec Date # readListPrec :: ReadPrec [Date] #
Show Date #
Methods showsPrec :: Int -> Date -> ShowS # show :: Date -> String # showList :: [Date] -> ShowS #

newtype Description #

Constructors

Description
Fields unDescription :: Text

Instances

Eq Description #
Methods (==) :: Description -> Description -> Bool # (/=) :: Description -> Description -> Bool #
Ord Description #
Methods compare :: Description -> Description -> Ordering # (<) :: Description -> Description -> Bool # (<=) :: Description -> Description -> Bool # (>) :: Description -> Description -> Bool # (>=) :: Description -> Description -> Bool # max :: Description -> Description -> Description # min :: Description -> Description -> Description #
Read Description #
Methods readsPrec :: Int -> ReadS Description # readList :: ReadS [Description] # readPrec :: ReadPrec Description # readListPrec :: ReadPrec [Description] #
Show Description #
Methods showsPrec :: Int -> Description -> ShowS # show :: Description -> String # showList :: [Description] -> ShowS #
IsString Description #
Methods fromString :: String -> Description #
Monoid Description #
Methods mempty :: Description # mappend :: Description -> Description -> Description # mconcat :: [Description] -> Description #

newtype SubDescription #

Constructors

SubDescription
Fields unSubDescription :: Text

Instances

Eq SubDescription #
Methods (==) :: SubDescription -> SubDescription -> Bool # (/=) :: SubDescription -> SubDescription -> Bool #
Ord SubDescription #
Methods compare :: SubDescription -> SubDescription -> Ordering # (<) :: SubDescription -> SubDescription -> Bool # (<=) :: SubDescription -> SubDescription -> Bool # (>) :: SubDescription -> SubDescription -> Bool # (>=) :: SubDescription -> SubDescription -> Bool # max :: SubDescription -> SubDescription -> SubDescription # min :: SubDescription -> SubDescription -> SubDescription #
Read SubDescription #
Methods readsPrec :: Int -> ReadS SubDescription # readList :: ReadS [SubDescription] # readPrec :: ReadPrec SubDescription # readListPrec :: ReadPrec [SubDescription] #
Show SubDescription #
Methods showsPrec :: Int -> SubDescription -> ShowS # show :: SubDescription -> String # showList :: [SubDescription] -> ShowS #
IsString SubDescription #
Methods fromString :: String -> SubDescription #
Monoid SubDescription #
Methods mempty :: SubDescription # mappend :: SubDescription -> SubDescription -> SubDescription # mconcat :: [SubDescription] -> SubDescription #

newtype Amount #

Constructors

Amount
Fields unAmount :: Int

Instances

Eq Amount #
Methods (==) :: Amount -> Amount -> Bool # (/=) :: Amount -> Amount -> Bool #
Num Amount #
Methods (+) :: Amount -> Amount -> Amount # (-) :: Amount -> Amount -> Amount # (*) :: Amount -> Amount -> Amount # negate :: Amount -> Amount # abs :: Amount -> Amount # signum :: Amount -> Amount # fromInteger :: Integer -> Amount #
Ord Amount #
Methods compare :: Amount -> Amount -> Ordering # (<) :: Amount -> Amount -> Bool # (<=) :: Amount -> Amount -> Bool # (>) :: Amount -> Amount -> Bool # (>=) :: Amount -> Amount -> Bool # max :: Amount -> Amount -> Amount # min :: Amount -> Amount -> Amount #
Read Amount #
Methods readsPrec :: Int -> ReadS Amount # readList :: ReadS [Amount] # readPrec :: ReadPrec Amount # readListPrec :: ReadPrec [Amount] #
Show Amount #
Methods showsPrec :: Int -> Amount -> ShowS # show :: Amount -> String # showList :: [Amount] -> ShowS #

data Category #

A type representing an accounts title.

Constructors

Category
Fields cName :: CategoryName cType :: CategoryType

Instances

Eq Category #
Methods (==) :: Category -> Category -> Bool # (/=) :: Category -> Category -> Bool #
Ord Category #
Methods compare :: Category -> Category -> Ordering # (<) :: Category -> Category -> Bool # (<=) :: Category -> Category -> Bool # (>) :: Category -> Category -> Bool # (>=) :: Category -> Category -> Bool # max :: Category -> Category -> Category # min :: Category -> Category -> Category #
Read Category #
Methods readsPrec :: Int -> ReadS Category # readList :: ReadS [Category] # readPrec :: ReadPrec Category # readListPrec :: ReadPrec [Category] #
Show Category #
Methods showsPrec :: Int -> Category -> ShowS # show :: Category -> String # showList :: [Category] -> ShowS #

newtype CategoryName #

Constructors

CategoryName
Fields unCategoryName :: Text

Instances

Eq CategoryName #
Methods (==) :: CategoryName -> CategoryName -> Bool # (/=) :: CategoryName -> CategoryName -> Bool #
Ord CategoryName #
Methods compare :: CategoryName -> CategoryName -> Ordering # (<) :: CategoryName -> CategoryName -> Bool # (<=) :: CategoryName -> CategoryName -> Bool # (>) :: CategoryName -> CategoryName -> Bool # (>=) :: CategoryName -> CategoryName -> Bool # max :: CategoryName -> CategoryName -> CategoryName # min :: CategoryName -> CategoryName -> CategoryName #
Read CategoryName #
Methods readsPrec :: Int -> ReadS CategoryName # readList :: ReadS [CategoryName] # readPrec :: ReadPrec CategoryName # readListPrec :: ReadPrec [CategoryName] #
Show CategoryName #
Methods showsPrec :: Int -> CategoryName -> ShowS # show :: CategoryName -> String # showList :: [CategoryName] -> ShowS #
IsString CategoryName #
Methods fromString :: String -> CategoryName #

data CategoryType #

Constructors

Assets
Liabilities
Stock
Revenue
Expenses

Instances

Enum CategoryType #
Methods succ :: CategoryType -> CategoryType # pred :: CategoryType -> CategoryType # toEnum :: Int -> CategoryType # fromEnum :: CategoryType -> Int # enumFrom :: CategoryType -> [CategoryType] # enumFromThen :: CategoryType -> CategoryType -> [CategoryType] # enumFromTo :: CategoryType -> CategoryType -> [CategoryType] # enumFromThenTo :: CategoryType -> CategoryType -> CategoryType -> [CategoryType] #
Eq CategoryType #
Methods (==) :: CategoryType -> CategoryType -> Bool # (/=) :: CategoryType -> CategoryType -> Bool #
Ord CategoryType #
Methods compare :: CategoryType -> CategoryType -> Ordering # (<) :: CategoryType -> CategoryType -> Bool # (<=) :: CategoryType -> CategoryType -> Bool # (>) :: CategoryType -> CategoryType -> Bool # (>=) :: CategoryType -> CategoryType -> Bool # max :: CategoryType -> CategoryType -> CategoryType # min :: CategoryType -> CategoryType -> CategoryType #
Read CategoryType #
Methods readsPrec :: Int -> ReadS CategoryType # readList :: ReadS [CategoryType] # readPrec :: ReadPrec CategoryType # readListPrec :: ReadPrec [CategoryType] #
Show CategoryType #
Methods showsPrec :: Int -> CategoryType -> ShowS # show :: CategoryType -> String # showList :: [CategoryType] -> ShowS #

newtype DebitCategory #

Constructors

DebitCategory
Fields unDebitCategory :: Category

Instances

Eq DebitCategory #
Methods (==) :: DebitCategory -> DebitCategory -> Bool # (/=) :: DebitCategory -> DebitCategory -> Bool #
Ord DebitCategory #
Methods compare :: DebitCategory -> DebitCategory -> Ordering # (<) :: DebitCategory -> DebitCategory -> Bool # (<=) :: DebitCategory -> DebitCategory -> Bool # (>) :: DebitCategory -> DebitCategory -> Bool # (>=) :: DebitCategory -> DebitCategory -> Bool # max :: DebitCategory -> DebitCategory -> DebitCategory # min :: DebitCategory -> DebitCategory -> DebitCategory #
Read DebitCategory #
Methods readsPrec :: Int -> ReadS DebitCategory # readList :: ReadS [DebitCategory] # readPrec :: ReadPrec DebitCategory # readListPrec :: ReadPrec [DebitCategory] #
Show DebitCategory #
Methods showsPrec :: Int -> DebitCategory -> ShowS # show :: DebitCategory -> String # showList :: [DebitCategory] -> ShowS #

newtype CreditCategory #

Constructors

CreditCategory
Fields unCreditCategory :: Category

Instances

Eq CreditCategory #
Methods (==) :: CreditCategory -> CreditCategory -> Bool # (/=) :: CreditCategory -> CreditCategory -> Bool #
Ord CreditCategory #
Methods compare :: CreditCategory -> CreditCategory -> Ordering # (<) :: CreditCategory -> CreditCategory -> Bool # (<=) :: CreditCategory -> CreditCategory -> Bool # (>) :: CreditCategory -> CreditCategory -> Bool # (>=) :: CreditCategory -> CreditCategory -> Bool # max :: CreditCategory -> CreditCategory -> CreditCategory # min :: CreditCategory -> CreditCategory -> CreditCategory #
Read CreditCategory #
Methods readsPrec :: Int -> ReadS CreditCategory # readList :: ReadS [CreditCategory] # readPrec :: ReadPrec CreditCategory # readListPrec :: ReadPrec [CreditCategory] #
Show CreditCategory #
Methods showsPrec :: Int -> CreditCategory -> ShowS # show :: CreditCategory -> String # showList :: [CreditCategory] -> ShowS #