Transaction

public class Transaction
extension Transaction: CustomStringConvertible
extension Transaction: Equatable
extension Transaction: Hashable
extension Transaction: Comparable

A Transaction has meta data as well as multiple postings

Show on GitHub

  • Meta data of the Transaction

    Declaration

    Swift

    public let metaData: TransactionMetaData
    Show on GitHub

  • Arrary of the Postings of the transaction.

    Should at least have two elements, otherwise the Transaction is not valid

    Declaration

    Swift

    public var postings: [TransactionPosting] { get }
    Show on GitHub

  • Creates a transaction

    Declaration

    Swift

    public init(metaData: TransactionMetaData, postings: [Posting])

    Parameters

    metaData
    postings

    Postings
    Show on GitHub

  • Gets the balance of a transaction, should be zero (within tolerance)

    This method just adds up the balances of the individual postings

    Throws

    if the balances cannot be calculated

    Declaration

    Swift

    public func balance(in ledger: Ledger) throws -> MultiCurrencyAmount

    Parameters

    ledger

    ledger to calculate in

    Return Value

    MultiCurrencyAmount

    Show on GitHub

  • Returns the effect (income + expenses) a transaction has

    This methods adds up the amount of all postings from income and expense accounts in the transaction

    Throws

    if the effect cannot be calculated

    Declaration

    Swift

    public func effect(in ledger: Ledger) throws -> MultiCurrencyAmount

    Parameters

    ledger

    ledger to calculate in

    Return Value

    MultiCurrencyAmount

    Show on GitHub

  • the `String representation of this transaction for the ledger file

    Declaration

    Swift

    public var description: String { get }
    Show on GitHub

  • Checks if two transactions are the same

    This means the metaData and all postings must be the same

    Declaration

    Swift

    public static func == (lhs: Transaction, rhs: Transaction) -> Bool

    Parameters

    lhs

    first transaction
    rhs

    second transaction

    Return Value

    if they are the same

    Show on GitHub

  • Declaration

    Swift

    public func hash(into hasher: inout Hasher)
    Show on GitHub

  • Declaration

    Swift

    public static func < (lhs: Transaction, rhs: Transaction) -> Bool
    Show on GitHub