Haspara.Accounting.Account

This module provides definitions for acccounts and types of accounts as they are used in accounting reporting.

Account Kind

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

Bounded AccountKind

Defined in Haspara.Accounting.Account

Methods

minBound :: AccountKind

maxBound :: AccountKind

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.4-91kyQ1gsJrx6JOOKY5ajCi" '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"

Account

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.4-91kyQ1gsJrx6JOOKY5ajCi" 'False) (C1 ('MetaCons "Account" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountKind") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 AccountKind) :*: S1 ('MetaSel ('Just "accountObject") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 o)))