Ledger.Types

Description

Most data types are defined here to avoid import cycles. Here is an overview of the hledger data model:

 Ledger              -- hledger's ledger is a journal file plus cached/derived data
  Journal            -- a representation of the journal file, containing..
   [Transaction]     -- ..journal transactions, which have date, status, code, description and..
    [Posting]        -- ..two or more account postings (account name and amount)
  Tree AccountName   -- all account names as a tree
  Map AccountName Account -- a map from account name to account info (postings and balances)

For more detailed documentation on each type, see the corresponding modules.

Terminology has been in flux:

ledger 2 had entries containing transactions.
hledger 0.4 had Entrys containing RawTransactions, which were flattened to Transactions.
ledger 3 has transactions containing postings.
hledger 0.5 had LedgerTransactions containing Postings, which were flattened to Transactions.
hledger 0.8 has Transactions containing Postings, and no flattened type.

Synopsis

type SmartDate = (String, String, String)

data WhichDate

= ActualDate

| EffectiveDate

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 PostingType

= RegularPosting

| VirtualPosting

| BalancedVirtualPosting

data Posting = Posting {

pstatus :: Bool

paccount :: AccountName

pamount :: MixedAmount

pcomment :: String

ptype :: PostingType

ptransaction :: Maybe Transaction

}

data Transaction = Transaction {

tdate :: Day

teffectivedate :: Maybe Day

tstatus :: Bool

tcode :: String

tdescription :: String

tcomment :: String

tpostings :: [Posting]

tpreceding_comment_lines :: String

}

data ModifierTransaction = ModifierTransaction {

mtvalueexpr :: String

mtpostings :: [Posting]

}

data PeriodicTransaction = PeriodicTransaction {

ptperiodicexpr :: String

ptpostings :: [Posting]

}

data TimeLogCode

= SetBalance

| SetRequiredHours

| In

| Out

| FinalOut

data TimeLogEntry = TimeLogEntry {

tlcode :: TimeLogCode

tldatetime :: LocalTime

tlcomment :: String

}

data HistoricalPrice = HistoricalPrice {

hdate :: Day

hsymbol :: String

hamount :: MixedAmount

}

data Journal = Journal {

jmodifiertxns :: [ModifierTransaction]

jperiodictxns :: [PeriodicTransaction]

jtxns :: [Transaction]

open_timelog_entries :: [TimeLogEntry]

historical_prices :: [HistoricalPrice]

final_comment_lines :: String

filepath :: FilePath

filereadtime :: ClockTime

jtext :: String

}

data Account = Account {

aname :: AccountName

apostings :: [Posting]

abalance :: MixedAmount

}

data Ledger = Ledger {

journal :: Journal

accountnametree :: Tree AccountName

accountmap :: Map AccountName Account

}

data FilterSpec = FilterSpec {

datespan :: DateSpan

cleared :: Maybe Bool

real :: Bool

empty :: Bool

costbasis :: Bool

acctpats :: [String]

descpats :: [String]

whichdate :: WhichDate

depth :: Maybe Int

}

Documentation

type SmartDate = (String, String, String)

Source

data WhichDate

Source

Constructors

ActualDate
EffectiveDate

Instances

Eq WhichDate

Show WhichDate

data DateSpan

Source

Constructors

DateSpan (Maybe Day) (Maybe Day)

Instances

data Interval

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

data Commodity

Constructors

Commodity

symbol :: String	the commodity's symbol display preferences for amounts of this commodity
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

data Amount

Constructors

Amount

commodity :: Commodity
quantity :: Double
price :: Maybe MixedAmount	unit price/conversion rate for this amount at posting time

Instances

newtype MixedAmount

Source

Constructors

Mixed [Amount]

Instances

data PostingType

Constructors

RegularPosting
VirtualPosting
BalancedVirtualPosting

Instances

Eq PostingType

Show PostingType

data Posting

Source

Constructors

Posting

pstatus :: Bool
paccount :: AccountName
pamount :: MixedAmount
pcomment :: String
ptype :: PostingType
ptransaction :: Maybe Transaction	this posting's parent transaction (co-recursive types). Tying this knot gets tedious, Maybe makes it easier/optional.

Instances

Eq Posting

Show Posting

data Transaction

Source

Constructors

Transaction

tdate :: Day
teffectivedate :: Maybe Day
tstatus :: Bool
tcode :: String
tdescription :: String
tcomment :: String
tpostings :: [Posting]
tpreceding_comment_lines :: String

Instances

Eq Transaction

Show Transaction

data ModifierTransaction

Source

Constructors

ModifierTransaction

mtvalueexpr :: String
mtpostings :: [Posting]

Instances

Eq ModifierTransaction

Show ModifierTransaction

data PeriodicTransaction

Source

Constructors

PeriodicTransaction

ptperiodicexpr :: String
ptpostings :: [Posting]

Instances

Eq PeriodicTransaction

Show PeriodicTransaction

data TimeLogCode

Source

Constructors

SetBalance
SetRequiredHours
In
Out
FinalOut

Instances

data TimeLogEntry

Source

Constructors

TimeLogEntry

tlcode :: TimeLogCode
tldatetime :: LocalTime
tlcomment :: String

Instances

Eq TimeLogEntry

Ord TimeLogEntry

Show TimeLogEntry

data HistoricalPrice

Source

Constructors

HistoricalPrice

hdate :: Day
hsymbol :: String
hamount :: MixedAmount

Instances

Eq HistoricalPrice

Show HistoricalPrice

data Journal

Source

Constructors

Journal

jmodifiertxns :: [ModifierTransaction]
jperiodictxns :: [PeriodicTransaction]
jtxns :: [Transaction]
open_timelog_entries :: [TimeLogEntry]
historical_prices :: [HistoricalPrice]
final_comment_lines :: String
filepath :: FilePath
filereadtime :: ClockTime
jtext :: String

Instances

Eq Journal

Show Journal

data Account

Source

Constructors

Account

aname :: AccountName
apostings :: [Posting]	transactions in this account
abalance :: MixedAmount	sum of transactions in this account and subaccounts

Instances

Eq Account

Show Account

data Ledger

Source

Constructors

Ledger

journal :: Journal
accountnametree :: Tree AccountName
accountmap :: Map AccountName Account

Instances

Show Ledger

Typeable Ledger

data FilterSpec

Source

A generic, pure specification of how to filter transactions/postings. This exists to keep app-specific options out of the hledger library.

Constructors

FilterSpec

datespan :: DateSpan	only include if in this date span
cleared :: Maybe Bool	only include if cleared/uncleared/don't care
real :: Bool	only include if real/don't care
empty :: Bool	include if empty (ie amount is zero)
costbasis :: Bool	convert all amounts to cost basis
acctpats :: [String]	only include if matching these account patterns
descpats :: [String]	only include if matching these description patterns
whichdate :: WhichDate	which dates to use (actual or effective)
depth :: Maybe Int

Instances

Show FilterSpec

Produced by Haddock version 2.6.0