finAccountCalc Class

Represents Financial Calculations for an Account.
Implements I_ISObjectName

Methods

Name Description
Calculate Calculates.
CalculateExisting Calculates the future Account Schedule for an Account.
CalculateExistingSchedule Calculates the future Account Schedule for an Account, but does not touch the internal Schedule object. Instead it returns a separate Schedule object.
CalculateInterest Calculates the Regular Payment based upon the Interest value.
CalculatePayment Calculates the Payment required to complete the Account by the Maturity Date.
CalculateTerm Calculates the Term and Maturity Date given the Regular Payment.
Clone Clone this object. See remarks for more information.
ComparisonRateCalcLoad Loads the ComparisonRateCalc collection.
ComparisonRateCalcRefresh Forces the Comparison Rate Calculation object to be reloaded from the next time it is accessed.
DateMaturityResolved Will find the Maturity Date either from Number of Payments or Term - depending on Term Entry Method.
FromHtmlWidgetJsonString Update from an HTML Widget JSON-formatted String.
FromXmlString System Use Only
GetInterestInAdvanceAdjustment Indicates whether an Adjustment is required for Interest in Advance.
GetObjectName
GetOpeningValuesPreCalculation Returns values from "Opening" Standard Transactions prior to a Calculation. Opening means where Cycle="Opening" OR Cycle="Once" and also CycleFirstPeriod="Opening".
GetPaymentBalloon Returns the Balloon Payment date and value, if applicable.
GetPaymentRegularFinal Returns the Final Regular Payment date and value.
GetPaymentRegularFirst Returns the First Regular Payment date and value. Excludes Upfront Payment.
GetPaymentRegularUpfront Returns the Upfront Payment date and value, if applicable.
HasOpeningTransactions Returns True if there are any non-zero Opening Transactions.
HasPaymentOnOpeningDate Returns True if Payment is expected on the Date Opened.
InterestBackdatedTo The date Interest will be backdated to.
InterestChargedTo The date Interest has been charged to.
InterestTypeUpdate Updates the Interest Type, loading Rates etc from the Account Type if relevant.
LoadAccount Loads the current Calculation information for the parent Account.
LoadAccountType Sets the Account Type and optional Promotion and then loads default values.
LoadAccountTypePk Sets the Account Type and optional Promotion and then loads default values.
LoadAccountTypeStdTransactions Loads default Transactions from the Account Type (and Promotion).
OpeningDateUpdate Updates the Opening Date, adjusting Review Date (on parent Account) and Next Statement Date if relevant.
PaymentCycleUpdate Updates the Payment Cycle, adjusting Interest Cycle, Term and First Payment period if relevant.
PaymentFirstDateDefault The Date the First Payment is due to be made based upon default Account Type settings.
ResetToDefaults Resets information to Defaults based upon the current Account Type and Promotion.
SetModeTransactionEntry System Use Only
StandardTransactionsFromXmlString System Use Only
StartupInterestTypeUpdate Updates the Startup Interest Type, loading Rates etc from the Account Type if relevant.
SummaryLoad Loads the Summary collection.
SummaryRefresh Forces the Summary collection to be reloaded from the next time it is accessed.
TermCycleResolved Returns the Term Cycle adjusted for the current Maturity Date.
TermNumberOfPaymentsFromTerm System Use Only
ToHtmlWidgetJsonString Create a JSON-formatted String for use with HTML Widget controls.
ToXmlString Persists the Calculation object to an XML string. Used in Account Archives, for example.
TotalNonDirectDebitPaymentsDueToday Returns the total Payments Due today, excluding those to be Direct Debited.

Properties

Name Description
AccountCalcPk
AccountClass Read-Only The Class of Account.
AccountClassText Read-Only The Account Class in its String representation.
AccountPayArrangePk Read-Only
AccountPk Read-Only The primary key of this Account, if applicable.
AccountType Read-Only The Account Type object.
AccountTypeId Read-Only The Id of this Account's Account Type.
AccountTypePk Read-Only The primary key of this Account's Account Type.
AccountTypePromotionId Read-Only The Id of this Account's Promotion.
AccountTypePromotionPk Read-Only The primary key of this Account's Promotion.
CalculationCounter Read-Only
CalculationTermReRun Used in CalculateTerm to determine if an event script causes the function to re-run until the Term remains constant.
ComparisonRate Read-Only Returns the Comparison Rate for the Account.
ComparisonRateCalc Read-Only Returns a Comparison Rate Calculation object for Quote Accounts, otherwise returns Nothing.
ComparisonRateMaximum Read-Only The Maximum Comparison Rate for the Account (at the date opened).
ComparisonRateType Read-Only Returns the Comparison Rate Type for the Account.
ComparisonRateTypeText Read-Only Returns the Comparison Rate Type for the Account in its string representation.
ConsumerRegulationType Read-Only The Consumer Regulation Type applicable to this Account.
ConsumerRegulationTypeText Read-Only The Consumer Regulation Type applicable to this Account.
ContractedPaymentBalloon Read-Only The Contracted Balloon Payment Value.
ContractedPaymentCycle Read-Only The Contracted Payment Cycle.
ContractedPaymentCycleDescription Read-Only A text description of the Contracted Payment Cycle.
ContractedPaymentCycleFreqPA Read-Only
ContractedPaymentNextDate The date the next Contracted Payment is due to be made.
ContractedPaymentNextDateBegin The date the next Contracted Payment period begins.
ContractedPaymentNextDateEnd The date the next Contracted Payment period ends.
ContractedPaymentOverrides Read-Only The list of Contracted Payment overrides.
ContractedPaymentRegular Read-Only The Regular Contracted Payment Value.
ContractedPayments Read-Only Payments that are included in the Account Contract.
CreatedDate Read-Only The Local date and time this record was created.
CreatedUserId Read-Only The Id of the User that created this record.
CreatedUserPk Read-Only The primary key of the User that created this record.
CreatedUtcDate Read-Only The UTC date and time this record was created.
CreditLimit1 Credit Limit 1 for this Account.
CreditLimit2 Credit Limit 2 for this Account.
CreditLimit3 Credit Limit 3 for this Account.
DateMaturity The Date the Account is due to Mature. The property can only be set for Revolving Credit Loans that support a Maturity Date.
DateRestructured The Date the Account was Restructured.
DefaultInterestRate
DefaultInterestRateBasis Defines the basis for determining the Default Interest Rate.
DefaultInterestRateBasisText The basis for determining the Default Interest Rate in its String representation.
Description Description regarding the Account Calculation, eg Opening, Restructure.
Entity Read-Only
EntityPk Read-Only
InterestCycle The Interest Cycle.
InterestCycleDateFirst The Date of the first Interest Cycle.
InterestCycleDescription Read-Only A text description of the Interest Cycle.
InterestInstructionDown The Interest Instruction when Rates decrease for this Account.
InterestInstructionDownText The Interest Instruction when Rates decrease for this Account in its String representation.
InterestInstructionUp The Interest Instruction when Rates increase for this Account.
InterestInstructionUpText The Interest Instruction when Rates increase for this Account in its String representation.
InterestOverrides Read-Only Use to set a list of overriding Interest values whilst calculating a Quote.
InterestPaymentType For a Deposit, how Interest will be paid.
InterestPaymentTypeText For a Deposit, how Interest will be paid, in its String representation.
InterestRate
InterestRateFlat
InterestRatePremium
InterestRateTableId The Id of the Interest Rate Table.
InterestRateTableIdResolved Read-Only The Resolved Id of the Interest Rate Table.
InterestRateTablePk The primary key of this Interest Rate Table.
InterestType The Interest Type.
InterestTypeText The Interest Type in its String representation.
IsCalcVersionClosing Returns True if this is the "Closing" calculation loaded from a finAccountCalcVerison object.
IsCalcVersionFuture Read-Only Returns True if this is a "Future" calculation loaded from a finAccountCalcVerison object.
IsCalcVersionOpening Read-Only Returns True if this is the "Opening" calculation loaded from a finAccountCalcVerison object.
IsCalculationRequired Read-Only
IsDirty Read-Only
IsModeHistoric Read-Only
IsModePaymentArrangement Read-Only
IsModeRestructure Read-Only
IsOpeningCalculation Read-Only Returns True if this is the "Opening" calculation. Compare to IsRestructured.
IsQuote Read-Only
IsRestructured Read-Only Returns True if this is a "Restructured" calculation. Compare to IsOpeningCalculation.
MinimumPaymentBasis The Minimum Payment Basis.
MinimumPaymentBasisText The Minimum Payment Basis in its String representation.
MinimumPaymentDirectDebitFullBalance Determines whether the full balance is direct debited when the Minimum Payment is due.
MinimumPaymentDueDays The Minimum Payment days before due (after Statement).
MinimumPaymentDueDaysOverride Determines whether the Account overrides the Minimum Payment due days from the Account Type.
MinimumPaymentDueDaysResolved Read-Only The Minimum Payment days before due (after Statement) resolved. This takes into account MinimumPaymentDueDaysOverride.
MinimumPaymentHoldToDate The Minimum Payment 'Hold To' date, if the Hold To Period is "On Date".
MinimumPaymentHoldToDateResolved Read-Only The resolved Minimum Payment 'Hold To' date, ie on or prior to this date the Minimum Payment is Nil.
MinimumPaymentHoldToPeriod The Period before the First Minimum Payment is due.
MinimumPaymentInstalmentEndDate The Minimum Payment Instalment basis End Date.
MinimumPaymentInstalmentResidualValue The Minimum Payment Instalment basis Residual Value.
MinimumPaymentPercent The Minimum Payment Percentage.
MinimumPaymentValue The Minimum Payment Value.
OpeningBalance Read-Only The Opening Balance (for a Restructured Account).
OpeningBalanceFeeIB The Opening Balance of Interest Bearing Fees (for a Restructured Account).
OpeningBalanceFeeNIB The Opening Balance of Non-Interest Bearing Fees (for a Restructured Account).
OpeningBalanceInterest The Opening Balance of Interest (for a Restructured Account).
OpeningBalanceOverdue The Opening Overdue Balance (for a Restructured Account).
OpeningBalanceOverdueContractual The Opening Contractual Overdue Balance (for a Restructured Account).
OpeningBalancePrincipalIB The Opening Balance of Interest Bearing Principal (for a Restructured Account).
OpeningBalancePrincipalNIB The Opening Balance of Non-Interest Bearing Principal (for a Restructured Account).
OpeningDate The Opening Date for Calculations.
OptionInterestAccruedMethod The method of calculating Accrued Interest.
OptionInterestAccruedMethodText Read-Only The Accrued Interest Method in its String representation.
OptionInterestAlignFirst Align the first Interest date to the first Payment date?
OptionInterestAlignFirstResolved Read-Only Align the first Interest date to the first Payment date?
OptionInterestChargeOriginal
OptionInterestChargeUpfront
OptionInterestFixRateTable
OptionInterestFlatRate
OptionInterestOnInterest Is Interest charged on Interest?
OptionInterestRoundMethod The method of rounding Interest.
OptionInterestRoundMethodText Read-Only The Interest Rounding Method in its String representation.
OptionPaymentAllocationMethod The allocation method for Regular Payments on a Loan Account.
OptionPaymentAllocationMethodText The allocation method for Regular Payments on a Loan Account, in its String representation.
OptionPaymentDirectDebitBalloon Indicates whether to Direct Debit the Balloon Payment. Note, this corresponds to Me.Parent.PaymentDDBalloon.
OptionPaymentDirectDebitDateOpened Indicates whether to Direct Debit Payments on the Date the Account was Opened.
OptionPaymentDirectDebitExcludeDateOpened System Use Only Obsolete Indicates whether to NOT Direct Debit Account payments on the Date the Account was Opened.
OptionPaymentsFinalPlusBalloon
OptionPaymentsInAdvance Are Payments in Advance, ie at the beginning of a Payment Period? (False=Arrears)
OriginalDateMaturity Read-Only The original Maturity Date.
OriginalStatementCycle Read-Only The original Statement Cycle.
OriginalStatementCycleDescription Read-Only A text description of the original Statement Cycle.
OriginalStatementDateFirst Read-Only The date the original Statement is first due.
OriginalTermCycle Read-Only The original Term.
OriginalTermCycleDescription Read-Only The original Term's description.
OriginalTermCycleDescriptionResolved Read-Only
OriginalTermCycleResolved Read-Only Resolves the original Term, notably where entered as "On Date" or Maturity Date rolled forward.
OtherInterestRate
OtherInterestRateResolved Read-Only
OtherInterestType Read-Only The Other Interest Type (from the Account Type).
OtherInterestTypeText Read-Only The Other Interest Type (from the Account Type) in its String representation.
Parent Read-Only Returns the Parent Account object.
PaymentArrangementDate Read-Only The last date a Payment Arrangement was made (if any, since the last Account restructure).
PaymentArrangementDateFinal Read-Only The final payment date of the last Payment Arrangement (if any, since the last Account restructure).
PaymentBalloon The Balloon Payment Value.
PaymentBalloonAvailable Read-Only
PaymentCycle The Payment Cycle.
PaymentCycleDescription Read-Only A text description of the Payment Cycle.
PaymentCycleDescriptionWithoutCycleDays Read-Only A text description of the Payment Cycle, excluding the Cycle Days.
PaymentCycleFreqPA Read-Only
PaymentCycleTermDescription Read-Only System Use Only A description in the form of how finPOWER 5 displays the term.
PaymentDDStopMinimumPaymentsOnly
PaymentDDStopToDate Any payments that are due on or before this date will not be Direct Debited.
PaymentFinalDate Read-Only The Final Payment Date for the Account.
PaymentFinalDateHold In a Payment Arrangement and Restructure, should the Final Payment date be held.
PaymentFinalDateHoldDate In a Payment Arrangement and Restructure, the Final Payment date to hold to.
PaymentFinalDateHoldNumberPayments In a Payment Arrangement and Restructure, the number of Payments remaining.
PaymentFirstDate The Date the First Payment is due to be made.
PaymentFirstDatePeriod The Period before the First Payment is due.
PaymentFirstDateResolved Read-Only The Date the First Payment is due to be made.
PaymentNextDate The Date the Next Payment is due to be made.
PaymentNextDateBegin Read-Only
PaymentNextDateEnd Read-Only
PaymentRegular The Regular Payment Value.
PaymentRegularMissUntilDate The date expected Regular Payments, including Overriding Regular Payments, for Fixed Term Loan Accounts will not be added to the schedule - i.e. the Payment will be missed. Note, the Payment Due will still be added and will increase the Overdue Balance.
PaymentRegularOverride The Overriding Regular Payment Value (not actually used in Calculations).
PaymentUseAltPaySchedule Does the Account use an Alternate Payment Schedule to Minimum Payments?
Payments Read-Only
ResidualValue The Residual Value.
ResidualValueResolved Read-Only The Residual Value. Includes Revolving Credit Loans where Minimum Payment Basis is "Instalment" - as at the date supplied.
RestructureByWhom Who made the Restructure.
RestructureReason Reason for the Restructure.
RestructureType The Type of Restructure.
Schedule Read-Only
StandardTransactions Read-Only
StartupInterestPeriod The Startup Interest Period.
StartupInterestPeriodDescription Read-Only A text description of the Startup Interest Period.
StartupInterestRate
StartupInterestRateFlat
StartupInterestRatePremium
StartupInterestRateTableId The Id of the Startup Interest Rate Table.
StartupInterestRateTableIdResolved Read-Only The Resolved Id of the Startup Interest Rate Table.
StartupInterestRateTablePk The primary key of the Startup Interest Rate Table.
StartupInterestToDate The Date to Startup Interest ends (inclusive) IF the Startup Interest Period is "To Date".
StartupInterestToDateResolved Read-Only The Date the Startup Interest Period ends (inclusive).
StartupInterestType The Startup Interest Type.
StartupInterestTypeText The Startup Interest Type in its String representation.
StatementCycle The Statement Cycle.
StatementCycleDescription Read-Only A text description of the Statement Cycle.
StatementDateLast Read-Only The Date the last Statement was sent.
StatementDateNext The Date the next Statement is due (or first Statement for a new Account).
Summary Read-Only Returns a summary of the Schedule for Quote Accounts.
SuspendDefaultFees Read-Only
SuspendDefaultInterest Read-Only
SuspendFacilityFee Read-Only
SuspendInterest Read-Only
SuspendStandardTransactions Read-Only
SuspendWithdrawals Read-Only
Tag The Tag property can be used to store additional information regarding this object.
TagCalculate The Tag property can be used to store additional information regarding this object during every calculation.
TaxCategory Read-Only The Account's Tax Category.
TaxCategoryId The Id of the Account's Tax Category.
TaxCategoryPk The Primary Key of the Account's Tax Category.
TermCycle The Term of the Account.
TermCycleDescription Read-Only A text description of the Term.
TermCycleDescriptionResolved Read-Only Returns the Term Cycle's description adjusted for the current Maturity Date.
TermCycleOnDate If the Term of the Account is "On Date", the Maturity Date.
TermEntryMethod The Term Entry Method.
TermEntryMethodText The Term Entry Method in its String representation.
TermNumberOfPayments The Number of Payments to make the Term.
UnsuspendDefaultFees If Default Fees are currently suspended, override this and charge anyway.
UnsuspendDefaultInterest If Default Interest is currently suspended, override this and charge anyway.
UnsuspendFacilityFee If Facility Fees are currently suspended, override this and charge anyway.
UnsuspendInterest If Interest is currently suspended, override this and charge anyway.
UnsuspendStandardTransactions If Standard Transactions are currently suspended, override this and charge anyway.
WhatIfs Read-Only

Fields

Name Description
NewAccountWizard_InterestCycleUpdateable
NewAccountWizard_InterestRateUpdateable
NewAccountWizard_StartupInterestRateUpdateable
Namespace:
Intersoft.finSupport6
Assembly:
finSupport6, Version=6.0.3
Target Framework:
.NET 9.0