Hledger.Cli.Commands.Convert

Convert account data in CSV format (eg downloaded from a bank) to journal format, and print it on stdout. See the manual for more details.

Documentation

data CsvRules

A set of data definitions and account-matching patterns sufficient to convert a particular CSV data file into meaningful journal transactions. See above.

Constructors

CsvRules

Fields

dateField :: Maybe FieldPosition

statusField :: Maybe FieldPosition

codeField :: Maybe FieldPosition

descriptionField :: Maybe FieldPosition

amountField :: Maybe FieldPosition

currencyField :: Maybe FieldPosition

baseCurrency :: Maybe String

baseAccount :: AccountName

accountRules :: [AccountRule]

Instances

Eq CsvRules

Show CsvRules

type FieldPosition = Int

type AccountRule = ([(String, Maybe String)], AccountName)

type CsvRecord = [String]

convert :: [Opt] -> [String] -> Journal -> IO ()

Read the CSV file named as an argument and print equivalent journal transactions, using/creating a .rules file.

maxFieldIndex :: CsvRules -> Int

The highest (0-based) field index referenced in the field definitions, or -1 if no fields are defined.

rulesFileFor :: FilePath -> FilePath

initialRulesFileContent :: String

parseCsvRulesFile :: FilePath -> IO (Either ParseError CsvRules)

parseCsvRules :: FilePath -> String -> Either ParseError CsvRules

csvrulesfile :: GenParser Char CsvRules CsvRules

definitions :: GenParser Char CsvRules ()

Real independent parser choice, even when alternative matches share a prefix.

accountrule :: GenParser Char CsvRules AccountRule

printTxn :: Bool -> CsvRules -> CsvRecord -> IO ()

transactionFromCsvRecord :: CsvRules -> CsvRecord -> Transaction

normaliseDate :: String -> String

Convert some date string with unknown format to YYYYMMDD.

identify :: [AccountRule] -> String -> String -> (String, String)

Apply account matching rules to a transaction description to obtain the most appropriate account and a new description.