Hledger.Data.Types

Description

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

 Journal                  -- a journal is derived from one or more data files. It contains..
  [Transaction]           -- journal transactions, which have date, status, code, description and..
   [Posting]              -- multiple account postings (entries), which have account name and amount.
  [HistoricalPrice]       -- historical commodity prices

 Ledger                   -- a ledger is derived from a journal, by applying a filter specification and doing some further processing. It contains..
  Journal                 -- the filtered journal, containing only the transactions and postings we are interested in
  Tree AccountName        -- account names referenced in the journal's transactions, as a tree
  Map AccountName Account -- per-account postings and balances from the journal's transactions, as a  map from account name to account info

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

Evolution of transaction/entry/posting terminology:

ledger 2: entries contain transactions
hledger 0.4: Entrys contain RawTransactions (which are flattened to Transactions)
ledger 3: transactions contain postings
hledger 0.5: LedgerTransactions contain Postings (which are flattened to Transactions)
hledger 0.8: Transactions contain Postings (referencing Transactions..)

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 Ledger = Ledger {

journal :: Journal

accountnametree :: Tree AccountName

accountmap :: Map AccountName Account

}

data Account = Account {

aname :: AccountName

apostings :: [Posting]

abalance :: MixedAmount

}

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

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

Eq Commodity

Ord Commodity

Show Commodity

data Amount

Source

Constructors

Amount

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

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 PostingType

Source

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]	this transaction's postings (co-recursive types).
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

Eq TimeLogCode

Ord TimeLogCode

Read TimeLogCode

Show TimeLogCode

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

Typeable Journal

data Ledger

Source

Constructors

Ledger

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

Instances

Show Ledger

data Account

Source

Constructors

Account

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

Instances

Eq Account

Show Account

data FilterSpec

Source

A generic, pure specification of how to filter transactions and postings.

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.1