Haspara.Accounting

This module provides a collection of definitions for a rudimentary accounting functionality.

Documentation

data Account o

Type encoding for account values.

This definition provides both the AccountKind and an arbitrary object identifying the account. This arbitrary nature provides flexibility to use-site to use its own account identity and accompanying information when required.

>>> let acc = Account AccountKindAsset (1 ::Int)
>>> Data.Aeson.encode acc
"{\"kind\":\"ASSET\",\"object\":1}"
>>> Data.Aeson.decode @(Account Int) (Data.Aeson.encode acc)
Just (Account {accountKind = AccountKindAsset, accountObject = 1})
>>> Data.Aeson.decode (Data.Aeson.encode acc) == Just acc
True

Constructors

Account

Fields

• accountKind :: !AccountKind
• accountObject :: !o

Instances

Eq o => Eq (Account o)

Defined in Haspara.Accounting.Account

Methods

(==) :: Account o -> Account o -> Bool

(/=) :: Account o -> Account o -> Bool

Ord o => Ord (Account o)

Defined in Haspara.Accounting.Account

Methods

compare :: Account o -> Account o -> Ordering

(<) :: Account o -> Account o -> Bool

(<=) :: Account o -> Account o -> Bool

(>) :: Account o -> Account o -> Bool

(>=) :: Account o -> Account o -> Bool

max :: Account o -> Account o -> Account o

min :: Account o -> Account o -> Account o

Show o => Show (Account o)

Defined in Haspara.Accounting.Account

Methods

showsPrec :: Int -> Account o -> ShowS

show :: Account o -> String

showList :: [Account o] -> ShowS

Generic (Account o)

Defined in Haspara.Accounting.Account

Associated Types

type Rep (Account o) :: Type -> Type

Methods

from :: Account o -> Rep (Account o) x

to :: Rep (Account o) x -> Account o

Hashable o => Hashable (Account o)

Defined in Haspara.Accounting.Account

Methods

hashWithSalt :: Int -> Account o -> Int

hash :: Account o -> Int

ToJSON o => ToJSON (Account o)

Defined in Haspara.Accounting.Account

Methods

toJSON :: Account o -> Value

toEncoding :: Account o -> Encoding

toJSONList :: [Account o] -> Value

toEncodingList :: [Account o] -> Encoding

FromJSON o => FromJSON (Account o)

Defined in Haspara.Accounting.Account

Methods

parseJSON :: Value -> Parser (Account o)

parseJSONList :: Value -> Parser [Account o]

type Rep (Account o)

Defined in Haspara.Accounting.Account

type Rep (Account o) = D1 ('MetaData "Account" "Haspara.Accounting.Account" "haspara-0.0.0.3-4zv1bokQoxCFAyBHZ5p8oz" 'False) (C1 ('MetaCons "Account" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountKind") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 AccountKind) :*: S1 ('MetaSel ('Just "accountObject") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 o)))

data AccountKind

Type encoding for ledger account type.

This type covers both balance sheet and income statement account types:

1. For balance sheet accounts:
2. Asset (AccountKindAsset)
3. Liability (AccountKindLiability)
4. Equity (AccountKindEquity)
5. For income statement accounts:
6. Revenue (AccountKindRevenue)
7. Expense (AccountKindExpense)

FromJSON and ToJSON instances, too:

>>> Data.Aeson.decode @AccountKind "\"ASSET\""
Just AccountKindAsset
>>> Data.Aeson.decode @AccountKind "\"LIABILITY\""
Just AccountKindLiability
>>> Data.Aeson.decode @AccountKind "\"EQUITY\""
Just AccountKindEquity
>>> Data.Aeson.decode @AccountKind "\"REVENUE\""
Just AccountKindRevenue
>>> Data.Aeson.decode @AccountKind "\"EXPENSE\""
Just AccountKindExpense
>>> Data.Aeson.encode AccountKindAsset
"\"ASSET\""
>>> Data.Aeson.encode AccountKindLiability
"\"LIABILITY\""
>>> Data.Aeson.encode AccountKindEquity
"\"EQUITY\""
>>> Data.Aeson.encode AccountKindRevenue
"\"REVENUE\""
>>> Data.Aeson.encode AccountKindExpense
"\"EXPENSE\""

Constructors

AccountKindAsset

AccountKindLiability

AccountKindEquity

AccountKindRevenue

AccountKindExpense

Instances

Enum AccountKind

Defined in Haspara.Accounting.Account

Methods

succ :: AccountKind -> AccountKind

pred :: AccountKind -> AccountKind

toEnum :: Int -> AccountKind

fromEnum :: AccountKind -> Int

enumFrom :: AccountKind -> [AccountKind]

enumFromThen :: AccountKind -> AccountKind -> [AccountKind]

enumFromTo :: AccountKind -> AccountKind -> [AccountKind]

enumFromThenTo :: AccountKind -> AccountKind -> AccountKind -> [AccountKind]

Eq AccountKind

Defined in Haspara.Accounting.Account

Methods

(==) :: AccountKind -> AccountKind -> Bool

(/=) :: AccountKind -> AccountKind -> Bool

Ord AccountKind

Defined in Haspara.Accounting.Account

Methods

compare :: AccountKind -> AccountKind -> Ordering

(<) :: AccountKind -> AccountKind -> Bool

(<=) :: AccountKind -> AccountKind -> Bool

(>) :: AccountKind -> AccountKind -> Bool

(>=) :: AccountKind -> AccountKind -> Bool

max :: AccountKind -> AccountKind -> AccountKind

min :: AccountKind -> AccountKind -> AccountKind

Show AccountKind

Defined in Haspara.Accounting.Account

Methods

showsPrec :: Int -> AccountKind -> ShowS

show :: AccountKind -> String

showList :: [AccountKind] -> ShowS

Generic AccountKind

Defined in Haspara.Accounting.Account

Associated Types

type Rep AccountKind :: Type -> Type

Methods

from :: AccountKind -> Rep AccountKind x

to :: Rep AccountKind x -> AccountKind

Hashable AccountKind

Defined in Haspara.Accounting.Account

Methods

hashWithSalt :: Int -> AccountKind -> Int

hash :: AccountKind -> Int

ToJSON AccountKind

Defined in Haspara.Accounting.Account

Methods

toJSON :: AccountKind -> Value

toEncoding :: AccountKind -> Encoding

toJSONList :: [AccountKind] -> Value

toEncodingList :: [AccountKind] -> Encoding

FromJSON AccountKind

Defined in Haspara.Accounting.Account

Methods

parseJSON :: Value -> Parser AccountKind

parseJSONList :: Value -> Parser [AccountKind]

type Rep AccountKind

Defined in Haspara.Accounting.Account

type Rep AccountKind = D1 ('MetaData "AccountKind" "Haspara.Accounting.Account" "haspara-0.0.0.3-4zv1bokQoxCFAyBHZ5p8oz" 'False) ((C1 ('MetaCons "AccountKindAsset" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AccountKindLiability" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "AccountKindEquity" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "AccountKindRevenue" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AccountKindExpense" 'PrefixI 'False) (U1 :: Type -> Type))))

accountKindText :: AccountKind -> Text

Provides textual representation of a given AccountKind.

>>> accountKindText AccountKindAsset
"Asset"
>>> accountKindText AccountKindLiability
"Liability"
>>> accountKindText AccountKindEquity
"Equity"
>>> accountKindText AccountKindRevenue
"Revenue"
>>> accountKindText AccountKindExpense
"Expense"

data Entry o (s :: Nat)

Encoding of a posting entry.

>>> :set -XDataKinds
>>> import Refined
>>> let date = read "2021-01-01"
>>> let oid = 1 :: Int
>>> let qty = $$(refineTH 42) :: UnsignedQuantity 2
>>> let entry = EntryDebit date oid qty
>>> let json = Aeson.encode entry
>>> json
"{\"qty\":42.0,\"type\":\"DEBIT\",\"obj\":1,\"date\":\"2021-01-01\"}"
>>> Aeson.decode json :: Maybe (Entry Int 2)
Just (EntryDebit 2021-01-01 1 (Refined 42.00))
>>> Aeson.decode json == Just entry
True

Constructors

EntryDebit Day o (UnsignedQuantity s)

EntryCredit Day o (UnsignedQuantity s)

Instances

Eq o => Eq (Entry o s)

Defined in Haspara.Accounting.Ledger

Methods

(==) :: Entry o s -> Entry o s -> Bool

(/=) :: Entry o s -> Entry o s -> Bool

Ord o => Ord (Entry o s)

Defined in Haspara.Accounting.Ledger

Methods

compare :: Entry o s -> Entry o s -> Ordering

(<) :: Entry o s -> Entry o s -> Bool

(<=) :: Entry o s -> Entry o s -> Bool

(>) :: Entry o s -> Entry o s -> Bool

(>=) :: Entry o s -> Entry o s -> Bool

max :: Entry o s -> Entry o s -> Entry o s

min :: Entry o s -> Entry o s -> Entry o s

(Show o, KnownNat s) => Show (Entry o s)

Defined in Haspara.Accounting.Ledger

Methods

showsPrec :: Int -> Entry o s -> ShowS

show :: Entry o s -> String

showList :: [Entry o s] -> ShowS

(ToJSON o, KnownNat s) => ToJSON (Entry o s)

Defined in Haspara.Accounting.Ledger

Methods

toJSON :: Entry o s -> Value

toEncoding :: Entry o s -> Encoding

toJSONList :: [Entry o s] -> Value

toEncodingList :: [Entry o s] -> Encoding

(FromJSON o, KnownNat s) => FromJSON (Entry o s)

Defined in Haspara.Accounting.Ledger

Methods

parseJSON :: Value -> Parser (Entry o s)

parseJSONList :: Value -> Parser [Entry o s]

buildEntry :: KnownNat s => Event o s -> AccountKind -> Entry o s

Consumes an event and a type of account, and produces a posting entry.

Note the following map as a guide:

Kind of account	Debit	Credit
Asset	Increase	Decrease
Liability	Decrease	Increase
Equity/Capital	Decrease	Increase
Income/Revenue	Decrease	Increase
ExpenseCostDividend	Increase	Decrease

data Event o (s :: Nat)

Type encoding of an economic increment/decrement event.

The event explicitly carries the date and quantity information along with a parameterized, arbitrary object providing the source of the event.

>>> :set -XDataKinds
>>> let date = read "2021-01-01"
>>> let oid = 1 :: Int
>>> let qty = $$(Refined.refineTH 42) :: UnsignedQuantity 2
>>> let event = EventDecrement date oid qty
>>> let json = Data.Aeson.encode event
>>> json
"{\"qty\":42.0,\"type\":\"DECREMENT\",\"obj\":1,\"date\":\"2021-01-01\"}"
>>> Data.Aeson.decode @(Event Int 2) json
Just (EventDecrement 2021-01-01 1 (Refined 42.00))
>>> Data.Aeson.decode json == Just event
True

Constructors

EventDecrement Day o (UnsignedQuantity s)

EventIncrement Day o (UnsignedQuantity s)

Instances

Eq o => Eq (Event o s)

Defined in Haspara.Accounting.Event

Methods

(==) :: Event o s -> Event o s -> Bool

(/=) :: Event o s -> Event o s -> Bool

Ord o => Ord (Event o s)

Defined in Haspara.Accounting.Event

Methods

compare :: Event o s -> Event o s -> Ordering

(<) :: Event o s -> Event o s -> Bool

(<=) :: Event o s -> Event o s -> Bool

(>) :: Event o s -> Event o s -> Bool

(>=) :: Event o s -> Event o s -> Bool

max :: Event o s -> Event o s -> Event o s

min :: Event o s -> Event o s -> Event o s

(Show o, KnownNat s) => Show (Event o s)

Defined in Haspara.Accounting.Event

Methods

showsPrec :: Int -> Event o s -> ShowS

show :: Event o s -> String

showList :: [Event o s] -> ShowS

(ToJSON o, KnownNat s) => ToJSON (Event o s)

Defined in Haspara.Accounting.Event

Methods

toJSON :: Event o s -> Value

toEncoding :: Event o s -> Encoding

toJSONList :: [Event o s] -> Value

toEncodingList :: [Event o s] -> Encoding

(FromJSON o, KnownNat s) => FromJSON (Event o s)

Defined in Haspara.Accounting.Event

Methods

parseJSON :: Value -> Parser (Event o s)

parseJSONList :: Value -> Parser [Event o s]

eventDate :: KnownNat s => Event o s -> Day

Returns the date of the event.

eventObject :: KnownNat s => Event o s -> o

Returns the source object of the event.

negateEvent :: KnownNat s => Event o s -> Event o s

Negates the event.

mkEvent

Arguments

:: MonadError String m

=> KnownNat s

=> Day

Date of the event.

-> o

Source object of the event.

-> Quantity s

Quantity of the event.

-> m (Event o s)

Smart constuctor for Event values.

newtype Posting a o (s :: Nat)

Type encoding for a posting.

>>> :set -XDataKinds
>>> import Haspara.Accounting
>>> import Refined
>>> import qualified Data.Aeson as Aeson
>>> import qualified Data.List.NonEmpty as NE
>>> let date = read "2021-01-01"
>>> let oid = 1 :: Int
>>> let qty = $$(refineTH 42) :: UnsignedQuantity 2
>>> let event = EventDecrement date oid qty
>>> let account = Account AccountKindAsset ("Cash" :: String, 1 ::Int)
>>> let posting =  Posting . NE.fromList $ [(event, account)]
>>> let json = Aeson.encode posting
>>> json
"[[{\"qty\":42.0,\"type\":\"DECREMENT\",\"obj\":1,\"date\":\"2021-01-01\"},{\"kind\":\"ASSET\",\"object\":[\"Cash\",1]}]]"
>>> Aeson.decode json :: Maybe (Posting (String, Int) Int 2)
Just (Posting ((EventDecrement 2021-01-01 1 (Refined 42.00),Account {accountKind = AccountKindAsset, accountObject = ("Cash",1)}) :| []))
>>> Aeson.decode json == Just posting
True

Constructors

Posting (NonEmpty (Event o s, Account a))

Instances

(Eq o, Eq a) => Eq (Posting a o s)

Defined in Haspara.Accounting.Ledger

Methods

(==) :: Posting a o s -> Posting a o s -> Bool

(/=) :: Posting a o s -> Posting a o s -> Bool

(Ord o, Ord a) => Ord (Posting a o s)

Defined in Haspara.Accounting.Ledger

Methods

compare :: Posting a o s -> Posting a o s -> Ordering

(<) :: Posting a o s -> Posting a o s -> Bool

(<=) :: Posting a o s -> Posting a o s -> Bool

(>) :: Posting a o s -> Posting a o s -> Bool

(>=) :: Posting a o s -> Posting a o s -> Bool

max :: Posting a o s -> Posting a o s -> Posting a o s

min :: Posting a o s -> Posting a o s -> Posting a o s

(KnownNat s, Show o, Show a) => Show (Posting a o s)

Defined in Haspara.Accounting.Ledger

Methods

showsPrec :: Int -> Posting a o s -> ShowS

show :: Posting a o s -> String

showList :: [Posting a o s] -> ShowS

Generic (Posting a o s)

Defined in Haspara.Accounting.Ledger

Associated Types

type Rep (Posting a o s) :: Type -> Type

Methods

from :: Posting a o s -> Rep (Posting a o s) x

to :: Rep (Posting a o s) x -> Posting a o s

(ToJSON a, ToJSON o, KnownNat s) => ToJSON (Posting a o s)

Defined in Haspara.Accounting.Ledger

Methods

toJSON :: Posting a o s -> Value

toEncoding :: Posting a o s -> Encoding

toJSONList :: [Posting a o s] -> Value

toEncodingList :: [Posting a o s] -> Encoding

(FromJSON a, FromJSON o, KnownNat s) => FromJSON (Posting a o s)

Defined in Haspara.Accounting.Ledger

Methods

parseJSON :: Value -> Parser (Posting a o s)

parseJSONList :: Value -> Parser [Posting a o s]

type Rep (Posting a o s)

Defined in Haspara.Accounting.Ledger

type Rep (Posting a o s) = D1 ('MetaData "Posting" "Haspara.Accounting.Ledger" "haspara-0.0.0.3-4zv1bokQoxCFAyBHZ5p8oz" 'True) (C1 ('MetaCons "Posting" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NonEmpty (Event o s, Account a)))))

postingEvents :: KnownNat s => Posting a o s -> [o]

Returns the list of posting event sources.

post :: KnownNat s => Posting a o s -> [(Account a, Entry o s)]

Posts an event.

data Ledger a o (s :: Nat)

Type encoding of a ledger.

Constructors

Ledger

Fields

• ledgerAccount :: !(Account a)
• ledgerOpening :: !(Quantity s)
• ledgerClosing :: !(Quantity s)
• ledgerRunning :: ![LedgerItem o s]

Instances

(Eq a, Eq o) => Eq (Ledger a o s)

Defined in Haspara.Accounting.Ledger

Methods

(==) :: Ledger a o s -> Ledger a o s -> Bool

(/=) :: Ledger a o s -> Ledger a o s -> Bool

(Ord a, Ord o) => Ord (Ledger a o s)

Defined in Haspara.Accounting.Ledger

Methods

compare :: Ledger a o s -> Ledger a o s -> Ordering

(<) :: Ledger a o s -> Ledger a o s -> Bool

(<=) :: Ledger a o s -> Ledger a o s -> Bool

(>) :: Ledger a o s -> Ledger a o s -> Bool

(>=) :: Ledger a o s -> Ledger a o s -> Bool

max :: Ledger a o s -> Ledger a o s -> Ledger a o s

min :: Ledger a o s -> Ledger a o s -> Ledger a o s

(KnownNat s, Show a, Show o) => Show (Ledger a o s)

Defined in Haspara.Accounting.Ledger

Methods

showsPrec :: Int -> Ledger a o s -> ShowS

show :: Ledger a o s -> String

showList :: [Ledger a o s] -> ShowS

Generic (Ledger a o s)

Defined in Haspara.Accounting.Ledger

Associated Types

type Rep (Ledger a o s) :: Type -> Type

Methods

from :: Ledger a o s -> Rep (Ledger a o s) x

to :: Rep (Ledger a o s) x -> Ledger a o s

(ToJSON a, ToJSON o, KnownNat s) => ToJSON (Ledger a o s)

Defined in Haspara.Accounting.Ledger

Methods

toJSON :: Ledger a o s -> Value

toEncoding :: Ledger a o s -> Encoding

toJSONList :: [Ledger a o s] -> Value

toEncodingList :: [Ledger a o s] -> Encoding

(FromJSON a, FromJSON o, KnownNat s) => FromJSON (Ledger a o s)

Defined in Haspara.Accounting.Ledger

Methods

parseJSON :: Value -> Parser (Ledger a o s)

parseJSONList :: Value -> Parser [Ledger a o s]

type Rep (Ledger a o s)

Defined in Haspara.Accounting.Ledger

type Rep (Ledger a o s) = D1 ('MetaData "Ledger" "Haspara.Accounting.Ledger" "haspara-0.0.0.3-4zv1bokQoxCFAyBHZ5p8oz" 'False) (C1 ('MetaCons "Ledger" 'PrefixI 'True) ((S1 ('MetaSel ('Just "ledgerAccount") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Account a)) :*: S1 ('MetaSel ('Just "ledgerOpening") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Quantity s))) :*: (S1 ('MetaSel ('Just "ledgerClosing") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Quantity s)) :*: S1 ('MetaSel ('Just "ledgerRunning") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [LedgerItem o s]))))

data LedgerItem o (s :: Nat)

Type encoding of a ledger item.

Constructors

LedgerItem

Fields

• ledgerItemEntry :: !(Entry o s)
• ledgerItemBalance :: !(Quantity s)

Instances

Eq o => Eq (LedgerItem o s)

Defined in Haspara.Accounting.Ledger

Methods

(==) :: LedgerItem o s -> LedgerItem o s -> Bool

(/=) :: LedgerItem o s -> LedgerItem o s -> Bool

Ord o => Ord (LedgerItem o s)

Defined in Haspara.Accounting.Ledger

Methods

compare :: LedgerItem o s -> LedgerItem o s -> Ordering

(<) :: LedgerItem o s -> LedgerItem o s -> Bool

(<=) :: LedgerItem o s -> LedgerItem o s -> Bool

(>) :: LedgerItem o s -> LedgerItem o s -> Bool

(>=) :: LedgerItem o s -> LedgerItem o s -> Bool

max :: LedgerItem o s -> LedgerItem o s -> LedgerItem o s

min :: LedgerItem o s -> LedgerItem o s -> LedgerItem o s

(Show o, KnownNat s) => Show (LedgerItem o s)

Defined in Haspara.Accounting.Ledger

Methods

showsPrec :: Int -> LedgerItem o s -> ShowS

show :: LedgerItem o s -> String

showList :: [LedgerItem o s] -> ShowS

Generic (LedgerItem o s)

Defined in Haspara.Accounting.Ledger

Associated Types

type Rep (LedgerItem o s) :: Type -> Type

Methods

from :: LedgerItem o s -> Rep (LedgerItem o s) x

to :: Rep (LedgerItem o s) x -> LedgerItem o s

(ToJSON o, KnownNat s) => ToJSON (LedgerItem o s)

Defined in Haspara.Accounting.Ledger

Methods

toJSON :: LedgerItem o s -> Value

toEncoding :: LedgerItem o s -> Encoding

toJSONList :: [LedgerItem o s] -> Value

toEncodingList :: [LedgerItem o s] -> Encoding

(FromJSON o, KnownNat s) => FromJSON (LedgerItem o s)

Defined in Haspara.Accounting.Ledger

Methods

parseJSON :: Value -> Parser (LedgerItem o s)

parseJSONList :: Value -> Parser [LedgerItem o s]

type Rep (LedgerItem o s)

Defined in Haspara.Accounting.Ledger

type Rep (LedgerItem o s) = D1 ('MetaData "LedgerItem" "Haspara.Accounting.Ledger" "haspara-0.0.0.3-4zv1bokQoxCFAyBHZ5p8oz" 'False) (C1 ('MetaCons "LedgerItem" 'PrefixI 'True) (S1 ('MetaSel ('Just "ledgerItemEntry") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Entry o s)) :*: S1 ('MetaSel ('Just "ledgerItemBalance") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Quantity s))))

mkLedger :: KnownNat s => Account a -> Quantity s -> [Entry o s] -> Ledger a o s

Creates a ledger from a given list of Entry values.

addEntry :: KnownNat s => Ledger a o s -> Entry o s -> Ledger a o s

Adds a new entry to a ledger.

entryDate :: KnownNat s => Entry o s -> Day

Returns the date of the posting entry.

entryObject :: KnownNat s => Entry o s -> o

Returns the source object of the posting entry.

entryQuantity :: KnownNat s => Entry o s -> Quantity s

Returns the quantity of the posting entry.

entryDebit :: KnownNat s => Entry o s -> Maybe (UnsignedQuantity s)

Returns the debit quantity of the posting entry.

entryCredit :: KnownNat s => Entry o s -> Maybe (UnsignedQuantity s)

Returns the credit quantity of the posting entry.