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 () Source #

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 Source #

Convert from YearTransactions to Transactions.

month :: Month -> MonthTransactions -> YearTransactions Source #

Convert from MonthTransactions to YearTransactions.

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

Convert from DateTransactions to MonthTransactions.

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

categoryName :: Text -> Maybe Text -> CategoryName Source #

Converters

runTransactions :: Transactions -> [Journal] Source #

Take list of Journal out from Transactions.

Types

type Transactions = Transaction Journal Source #

type YearTransactions = Transaction (Year -> Journal) Source #

type MonthTransactions = Transaction (Month -> Year -> Journal) Source #

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

data Journal Source #

A type representing a transaction.

Constructors

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

Instances

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

data Year Source #

Instances

Enum Year Source #
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 Source #
Methods (==) :: Year -> Year -> Bool # (/=) :: Year -> Year -> Bool #
Integral Year Source #
Methods quot :: Year -> Year -> Year # rem :: Year -> Year -> Year # div :: Year -> Year -> Year # mod :: Year -> Year -> Year # quotRem :: Year -> Year -> (Year, Year) # divMod :: Year -> Year -> (Year, Year) # toInteger :: Year -> Integer #
Num Year Source #
Methods (+) :: Year -> Year -> Year # (-) :: Year -> Year -> Year # (*) :: Year -> Year -> Year # negate :: Year -> Year # abs :: Year -> Year # signum :: Year -> Year # fromInteger :: Integer -> Year #
Ord Year Source #
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 Source #
Methods readsPrec :: Int -> ReadS Year # readList :: ReadS [Year] # readPrec :: ReadPrec Year # readListPrec :: ReadPrec [Year] #
Real Year Source #
Methods toRational :: Year -> Rational #
Show Year Source #
Methods showsPrec :: Int -> Year -> ShowS # show :: Year -> String # showList :: [Year] -> ShowS #

data Month Source #

Instances

Enum Month Source #
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 Source #
Methods (==) :: Month -> Month -> Bool # (/=) :: Month -> Month -> Bool #
Integral Month Source #
Methods quot :: Month -> Month -> Month # rem :: Month -> Month -> Month # div :: Month -> Month -> Month # mod :: Month -> Month -> Month # quotRem :: Month -> Month -> (Month, Month) # divMod :: Month -> Month -> (Month, Month) # toInteger :: Month -> Integer #
Num Month Source #
Methods (+) :: Month -> Month -> Month # (-) :: Month -> Month -> Month # (*) :: Month -> Month -> Month # negate :: Month -> Month # abs :: Month -> Month # signum :: Month -> Month # fromInteger :: Integer -> Month #
Ord Month Source #
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 Source #
Methods readsPrec :: Int -> ReadS Month # readList :: ReadS [Month] # readPrec :: ReadPrec Month # readListPrec :: ReadPrec [Month] #
Real Month Source #
Methods toRational :: Month -> Rational #
Show Month Source #
Methods showsPrec :: Int -> Month -> ShowS # show :: Month -> String # showList :: [Month] -> ShowS #

data Date Source #

Instances

Enum Date Source #
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 Source #
Methods (==) :: Date -> Date -> Bool # (/=) :: Date -> Date -> Bool #
Integral Date Source #
Methods quot :: Date -> Date -> Date # rem :: Date -> Date -> Date # div :: Date -> Date -> Date # mod :: Date -> Date -> Date # quotRem :: Date -> Date -> (Date, Date) # divMod :: Date -> Date -> (Date, Date) # toInteger :: Date -> Integer #
Num Date Source #
Methods (+) :: Date -> Date -> Date # (-) :: Date -> Date -> Date # (*) :: Date -> Date -> Date # negate :: Date -> Date # abs :: Date -> Date # signum :: Date -> Date # fromInteger :: Integer -> Date #
Ord Date Source #
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 Source #
Methods readsPrec :: Int -> ReadS Date # readList :: ReadS [Date] # readPrec :: ReadPrec Date # readListPrec :: ReadPrec [Date] #
Real Date Source #
Methods toRational :: Date -> Rational #
Show Date Source #
Methods showsPrec :: Int -> Date -> ShowS # show :: Date -> String # showList :: [Date] -> ShowS #

data Description Source #

Instances

Eq Description Source #
Methods (==) :: Description -> Description -> Bool # (/=) :: Description -> Description -> Bool #
Ord Description Source #
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 Source #
Methods readsPrec :: Int -> ReadS Description # readList :: ReadS [Description] # readPrec :: ReadPrec Description # readListPrec :: ReadPrec [Description] #
Show Description Source #
Methods showsPrec :: Int -> Description -> ShowS # show :: Description -> String # showList :: [Description] -> ShowS #
IsString Description Source #
Methods fromString :: String -> Description #
Semigroup Description Source #
Methods (<>) :: Description -> Description -> Description # sconcat :: NonEmpty Description -> Description # stimes :: Integral b => b -> Description -> Description #
Monoid Description Source #
Methods mempty :: Description # mappend :: Description -> Description -> Description # mconcat :: [Description] -> Description #

unDescription :: Description -> Text Source #

data SubDescription Source #

Instances

Eq SubDescription Source #
Methods (==) :: SubDescription -> SubDescription -> Bool # (/=) :: SubDescription -> SubDescription -> Bool #
Ord SubDescription Source #
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 Source #
Methods readsPrec :: Int -> ReadS SubDescription # readList :: ReadS [SubDescription] # readPrec :: ReadPrec SubDescription # readListPrec :: ReadPrec [SubDescription] #
Show SubDescription Source #
Methods showsPrec :: Int -> SubDescription -> ShowS # show :: SubDescription -> String # showList :: [SubDescription] -> ShowS #
IsString SubDescription Source #
Methods fromString :: String -> SubDescription #
Semigroup SubDescription Source #
Methods (<>) :: SubDescription -> SubDescription -> SubDescription # sconcat :: NonEmpty SubDescription -> SubDescription # stimes :: Integral b => b -> SubDescription -> SubDescription #
Monoid SubDescription Source #
Methods mempty :: SubDescription # mappend :: SubDescription -> SubDescription -> SubDescription # mconcat :: [SubDescription] -> SubDescription #

unSubDescription :: SubDescription -> Text Source #

data Amount Source #

Instances

Enum Amount Source #
Methods succ :: Amount -> Amount # pred :: Amount -> Amount # toEnum :: Int -> Amount # fromEnum :: Amount -> Int # enumFrom :: Amount -> [Amount] # enumFromThen :: Amount -> Amount -> [Amount] # enumFromTo :: Amount -> Amount -> [Amount] # enumFromThenTo :: Amount -> Amount -> Amount -> [Amount] #
Eq Amount Source #
Methods (==) :: Amount -> Amount -> Bool # (/=) :: Amount -> Amount -> Bool #
Integral Amount Source #
Methods quot :: Amount -> Amount -> Amount # rem :: Amount -> Amount -> Amount # div :: Amount -> Amount -> Amount # mod :: Amount -> Amount -> Amount # quotRem :: Amount -> Amount -> (Amount, Amount) # divMod :: Amount -> Amount -> (Amount, Amount) # toInteger :: Amount -> Integer #
Num Amount Source #
Methods (+) :: Amount -> Amount -> Amount # (-) :: Amount -> Amount -> Amount # (*) :: Amount -> Amount -> Amount # negate :: Amount -> Amount # abs :: Amount -> Amount # signum :: Amount -> Amount # fromInteger :: Integer -> Amount #
Ord Amount Source #
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 Source #
Methods readsPrec :: Int -> ReadS Amount # readList :: ReadS [Amount] # readPrec :: ReadPrec Amount # readListPrec :: ReadPrec [Amount] #
Real Amount Source #
Methods toRational :: Amount -> Rational #
Show Amount Source #
Methods showsPrec :: Int -> Amount -> ShowS # show :: Amount -> String # showList :: [Amount] -> ShowS #

unAmount :: Amount -> Int Source #

data Category Source #

A type representing an accounts title.

Constructors

Category
Fields cName :: CategoryName cType :: CategoryType

Instances

Eq Category Source #
Methods (==) :: Category -> Category -> Bool # (/=) :: Category -> Category -> Bool #
Ord Category Source #
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 Source #
Methods readsPrec :: Int -> ReadS Category # readList :: ReadS [Category] # readPrec :: ReadPrec Category # readListPrec :: ReadPrec [Category] #
Show Category Source #
Methods showsPrec :: Int -> Category -> ShowS # show :: Category -> String # showList :: [Category] -> ShowS #

data CategoryName Source #

Instances

Eq CategoryName Source #
Methods (==) :: CategoryName -> CategoryName -> Bool # (/=) :: CategoryName -> CategoryName -> Bool #
Ord CategoryName Source #
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 Source #
Methods readsPrec :: Int -> ReadS CategoryName # readList :: ReadS [CategoryName] # readPrec :: ReadPrec CategoryName # readListPrec :: ReadPrec [CategoryName] #
Show CategoryName Source #
Methods showsPrec :: Int -> CategoryName -> ShowS # show :: CategoryName -> String # showList :: [CategoryName] -> ShowS #
IsString CategoryName Source #
Methods fromString :: String -> CategoryName #

unCategoryName :: CategoryName -> Text Source #

unCategorySubName :: CategoryName -> Maybe Text Source #

data CategoryType Source #

Constructors

Assets
Liabilities
Stock
Revenue
Expenses

Instances

Enum CategoryType Source #
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 Source #
Methods (==) :: CategoryType -> CategoryType -> Bool # (/=) :: CategoryType -> CategoryType -> Bool #
Ord CategoryType Source #
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 Source #
Methods readsPrec :: Int -> ReadS CategoryType # readList :: ReadS [CategoryType] # readPrec :: ReadPrec CategoryType # readListPrec :: ReadPrec [CategoryType] #
Show CategoryType Source #
Methods showsPrec :: Int -> CategoryType -> ShowS # show :: CategoryType -> String # showList :: [CategoryType] -> ShowS #

newtype DebitCategory Source #

Constructors

DebitCategory
Fields unDebitCategory :: Category

Instances

Eq DebitCategory Source #
Methods (==) :: DebitCategory -> DebitCategory -> Bool # (/=) :: DebitCategory -> DebitCategory -> Bool #
Ord DebitCategory Source #
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 Source #
Methods readsPrec :: Int -> ReadS DebitCategory # readList :: ReadS [DebitCategory] # readPrec :: ReadPrec DebitCategory # readListPrec :: ReadPrec [DebitCategory] #
Show DebitCategory Source #
Methods showsPrec :: Int -> DebitCategory -> ShowS # show :: DebitCategory -> String # showList :: [DebitCategory] -> ShowS #

newtype CreditCategory Source #

Constructors

CreditCategory
Fields unCreditCategory :: Category

Instances

Eq CreditCategory Source #
Methods (==) :: CreditCategory -> CreditCategory -> Bool # (/=) :: CreditCategory -> CreditCategory -> Bool #
Ord CreditCategory Source #
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 Source #
Methods readsPrec :: Int -> ReadS CreditCategory # readList :: ReadS [CreditCategory] # readPrec :: ReadPrec CreditCategory # readListPrec :: ReadPrec [CreditCategory] #
Show CreditCategory Source #
Methods showsPrec :: Int -> CreditCategory -> ShowS # show :: CreditCategory -> String # showList :: [CreditCategory] -> ShowS #