hledger-0.4: A ledger-compatible text-based accounting tool. Source code Contents Index

Ledger.Types

Description

This is the next layer up from Ledger.Utils. All main data types are defined here to avoid import cycles; see the corresponding modules for documentation.

Synopsis

type SmartDate = (String, String, String) data DateSpan = DateSpan (Maybe Day) (Maybe Day) data Interval = NoInterval | Daily | Weekly | Monthly | Quarterly | Yearly type AccountName = String data Side = L | R data Commodity = Commodity { symbol :: String side :: Side spaced :: Bool comma :: Bool precision :: Int } data Amount = Amount { commodity :: Commodity quantity :: Double price :: Maybe MixedAmount } newtype MixedAmount = Mixed [Amount] data TransactionType = RegularTransaction | VirtualTransaction | BalancedVirtualTransaction data RawTransaction = RawTransaction { tstatus :: Bool taccount :: AccountName tamount :: MixedAmount tcomment :: String rttype :: TransactionType } data ModifierEntry = ModifierEntry { valueexpr :: String m_transactions :: [RawTransaction] } data PeriodicEntry = PeriodicEntry { periodicexpr :: String p_transactions :: [RawTransaction] } data Entry = Entry { edate :: Day estatus :: Bool ecode :: String edescription :: String ecomment :: String etransactions :: [RawTransaction] epreceding_comment_lines :: String } data HistoricalPrice = HistoricalPrice { hdate :: Day hsymbol1 :: String hsymbol2 :: String hprice :: Double } data RawLedger = RawLedger { modifier_entries :: [ModifierEntry] periodic_entries :: [PeriodicEntry] entries :: [Entry] open_timelog_entries :: [TimeLogEntry] historical_prices :: [HistoricalPrice] final_comment_lines :: String } data TimeLogEntry = TimeLogEntry { tlcode :: Char tldatetime :: LocalTime tlcomment :: String } data TimeLog = TimeLog { timelog_entries :: [TimeLogEntry] } data Transaction = Transaction { entryno :: Int status :: Bool date :: Day description :: String account :: AccountName amount :: MixedAmount ttype :: TransactionType } data Account = Account { aname :: AccountName atransactions :: [Transaction] abalance :: MixedAmount } data Ledger = Ledger { rawledgertext :: String rawledger :: RawLedger accountnametree :: Tree AccountName accountmap :: Map AccountName Account }

Documentation

type SmartDate = (String, String, String) Source

data DateSpan Source

Constructors DateSpan (Maybe Day) (Maybe Day) Instances Eq DateSpan Ord DateSpan Show DateSpan

data Interval Source

Constructors NoInterval Daily Weekly Monthly Quarterly Yearly Instances Eq Interval Ord Interval Show Interval

type AccountName = String Source

data Side Source

Constructors L R Instances Eq Side Ord Side Show Side

data Commodity Source

Constructors Commodity symbol :: String the commodity's symbol side :: Side should the symbol appear on the left or the right spaced :: Bool should there be a space between symbol and quantity comma :: Bool should thousands be comma-separated precision :: Int number of decimal places to display Instances Eq Commodity Ord Commodity Show Commodity

data Amount Source

Constructors Amount commodity :: Commodity quantity :: Double price :: Maybe MixedAmount optional per-unit price for this amount at the time of entry Instances Eq Amount Num Amount Ord Amount Show Amount

newtype MixedAmount Source

Constructors Mixed [Amount] Instances Eq MixedAmount Num MixedAmount Ord MixedAmount Show MixedAmount

data TransactionType Source

Constructors RegularTransaction VirtualTransaction BalancedVirtualTransaction Instances Eq TransactionType Show TransactionType

data RawTransaction Source

Constructors RawTransaction tstatus :: Bool taccount :: AccountName tamount :: MixedAmount tcomment :: String rttype :: TransactionType Instances Eq RawTransaction Show RawTransaction

data ModifierEntry Source

a ledger modifier entry. Currently ignored. Constructors ModifierEntry valueexpr :: String m_transactions :: [RawTransaction] Instances Eq ModifierEntry Show ModifierEntry

data PeriodicEntry Source

a ledger periodic entry. Currently ignored. Constructors PeriodicEntry periodicexpr :: String p_transactions :: [RawTransaction] Instances Eq PeriodicEntry Show PeriodicEntry

data Entry Source

Constructors Entry edate :: Day estatus :: Bool ecode :: String edescription :: String ecomment :: String etransactions :: [RawTransaction] epreceding_comment_lines :: String Instances Eq Entry Show Entry

data HistoricalPrice Source

Constructors HistoricalPrice hdate :: Day hsymbol1 :: String hsymbol2 :: String hprice :: Double Instances Eq HistoricalPrice Show HistoricalPrice

data RawLedger Source

Constructors RawLedger modifier_entries :: [ModifierEntry] periodic_entries :: [PeriodicEntry] entries :: [Entry] open_timelog_entries :: [TimeLogEntry] historical_prices :: [HistoricalPrice] final_comment_lines :: String Instances Eq RawLedger Show RawLedger

data TimeLogEntry Source

Constructors TimeLogEntry tlcode :: Char tldatetime :: LocalTime tlcomment :: String Instances Eq TimeLogEntry Ord TimeLogEntry Show TimeLogEntry

data TimeLog Source

Constructors TimeLog timelog_entries :: [TimeLogEntry] Instances Eq TimeLog Show TimeLog

data Transaction Source

Constructors Transaction entryno :: Int status :: Bool date :: Day description :: String account :: AccountName amount :: MixedAmount ttype :: TransactionType Instances Eq Transaction Show Transaction

data Account Source

Constructors Account aname :: AccountName atransactions :: [Transaction] abalance :: MixedAmount Instances Eq Account Show Account

data Ledger Source

Constructors Ledger rawledgertext :: String rawledger :: RawLedger accountnametree :: Tree AccountName accountmap :: Map AccountName Account Instances Show Ledger

Produced by Haddock version 2.6.0