LedgerSettings

public struct LedgerSettings

Settings for SwiftBeanCountSheetSync which were read from the ledger file

Show on GitHub

  • Commodity symbol for all transactions - The syncronization only supports one commodity

    Declaration

    Swift

    public let commoditySymbol: String
    Show on GitHub
  • tag

    Tag which is appended to all transactions from the sheet

    Declaration

    Swift

    public let tag: Tag
    Show on GitHub

  • Name of the person of the ledger - used to identify the colunms of the sheet

    Declaration

    Swift

    public let name: String
    Show on GitHub

  • Account which is used to keep track of the balance between the people

    Declaration

    Swift

    public let accountName: AccountName
    Show on GitHub

  • tolerance used to detect already existing transactions

    Declaration

    Swift

    public let dateTolerance: TimeInterval
    Show on GitHub

  • Mapping from sheet categories to the corresponding account names in the ledger

    Declaration

    Swift

    public let categoryAccountNames: [String : AccountName]
    Show on GitHub

  • Mapping from account names in the ledger to the corresponding categories in the sheet

    Declaration

    Swift

    public let accountNameCategories: [String : String]
    Show on GitHub

  • Create the ledger settings from the data read from the ledger

    Declaration

    Swift

    public init(
    commoditySymbol: String,
    tag: Tag,
    name: String,
    accountName: AccountName,
    dateTolerance: TimeInterval,
    categoryAccountNames: [String: AccountName],
    accountNameCategories: [String: String]
)

    Parameters

    commoditySymbol

    commodity symbol
    tag

    Tag which is appended to all transactions from the sheet
    name

    Name of the person of the ledger
    accountName

    Account which is used to keep track of the balance between the people
    dateTolerance

    tolerance used to detect already existing transactions
    categoryAccountNames

    Mapping from sheet categories to the corresponding account names in the ledger
    accountNameCategories

    Mapping from account names in the ledger to the corresponding categories in the sheet
    Show on GitHub