CashFlowPayment class

Represents the movement of money, specifically interest bearing cash in-flows to the lender, for example loan repayments or lease rentals.

Constructors

CashFlowPayment({required DateTime postDate, double value = 0.0, bool isKnown = true, double weighting = 1.0, String label = '', double interest = 0.0, bool isInterestCapitalised = true, DayCountFactor? periodFactor})

hashCode → int: The hash code for this object.
no setterinherited
interest → double: The amortised interest included in this cash flow value when isInterestCapitalised is true. The difference between interest and the cash flow value is the amortised capital.
final
isInterestCapitalised → bool: Determines whether the interest accrued to date is capitalised (true) or rolled over (false). Default is true.
final
isKnown → bool: Flag indicating if the cash flow value is known, or is to be computed.
finalinherited
label → String: Localised free text description of the cash flow e.g. Loan, Payment, Fee, etc.
finalinherited
periodFactor → DayCountFactor?: finalinherited
postDate → DateTime: finalinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
value → double: The positive or negative cash flow value.
finalinherited
valueDate → DateTime: The settlement date of the cashflow value. It should not predate the post date.
finalinherited
weighting → double: Weighting determines the scale of an unknown cash flow value relative to other unknown cash flows in a cash flow series. Note, the weighting has no effect when applied to cash flows with known values. Default value is 1.0
finalinherited

copyWith({DateTime? postDate, double? value, bool? isKnown, double? weighting, String? label, double? interest, bool? isInterestCapitalised, DayCountFactor? periodFactor}) → CashFlowPayment
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
override