finAccountClose Class

Functionality to Close an Account.

Methods

Name Description
AccountLoad Loads the Account.
AccountLoadFromObject System Use Only Load from a pre-loaded Account object.
AccountLoadPk Load the Account.
AllowUpdateUI Indicates whether the User is allowed to update details in the User Interface, i.e. the Close Account wizard.
BankingDetailsFromHtmlWidgetJsonString System Use Only Obsolete Update Banking Details from a JSON String for use in HTML Widgets.
Calculate Updates Calculations based upon the Account, Date Closed and Closed Method.
CanCommitConsumerRegulationType Indicates whether the Close can be committed, or if Consumer Regulation restrictions means there are issues that need resolving.
Clear Clears this object and sets all of its properties to their defaults.
CreateRefinanceAccount Create an unsaved Account that is the result of Refinancing to a New Account.
CreateRefinanceAccountHtmlWidget Create an unsaved Account that is the result of Refinancing to a New Account.
CreateReinvestmentAccount Create an unsaved Account that is the result of Reinvesting to a New Account.
DisbursementsReset Resets and calculates Disbursement Recoveries.
ExecuteCommit Close the Account.
ExecuteCommitRefinanceHtmlWidget Refinance the Account (HTML Widget).
ExecuteCreateLog
ExecuteCreateSavedLog
FeeReset Reset Fee information from the Account and its Account Type.
FromXmlString Populates collection from an XML string.
GetBankingDetails System Use Only Obsolete Returns Banking details in a finBankingDetails object.
GetCloseMethodsAvailableTypesCodeDescriptionList Returns a Code Description List of the available Close Methods for the Account - based upon the User's Permissions.
LossCalculate Calculates the Loss based upon the Loss formula.
LossCalculate_NZ_CCCFR_Formula1 Calculates and updates Loss based upon the NZ CCCFR Formula 1.
LossCalculate_NZ_CCCFR_Formula1_WithCurrentInterestRate Calculates and updates Loss based upon the NZ CCCFR Formula 1 and the current equivalent Interest Rate.
LossReset Resets Loss details from the Account information and performs a calculation.
PaymentFeeCalculate Calculate the Payment Fee.
Reset
ResidualReset Reset Residual information from the Account and its Account Type.
SummaryReset Resets and calculates Credits against elements charged to the Account.
ToHtmlString System Use Only Obsolete
ToXmlString
Validate
WithholdingTaxReset Reset Withholding Tax details to the defaults for the Account on the Adjustment Date.

Properties

Name Description
Account Read-Only The Account.
AccountLogPk Read-Only Returns the Pk of the Account Log (that was optionally) created during ExecuteCommit.
AccruedDefaultInterest The value of Accrued Default Interest.
AccruedDefaultInterestCharge Charge Accrued Default Interest?
AccruedDefaultInterestOriginal Read-Only The value of Accrued Default Interest that was originally calculated.
AccruedDefaultInterestPostScript Read-Only The value of Accrued Default Interest calculated after the script has been run.
AccruedDefaultInterestResolved Read-Only Returns the value of Accrued DefaultInterest to be charged.
AccruedDefaultInterestSuspended Read-Only Is Default Interest currently suspended?
AccruedInterest The value of Accrued Interest.
AccruedInterestAllowChange Indicates whether the User can change the Accrued Interest.
AccruedInterestCharge Charge Accrued Interest.
AccruedInterestOriginal Read-Only The value of Accrued Interest that was originally calculated.
AccruedInterestPostScript Read-Only The value of Accrued Interest calculated after the script has been run.
AccruedInterestResolved Read-Only Returns the value of Accrued Interest to be charged.
AccruedInterestSuspended Read-Only Is Interest currently suspended?
AccruedOtherInterest The value of Accrued Other Interest.
AccruedOtherInterestAvailable Read-Only
AccruedOtherInterestCharge Charge Accrued Other Interest.
AccruedOtherInterestOriginal Read-Only The value of Accrued Other Interest that was originally calculated.
AccruedOtherInterestPostScript Read-Only The value of Accrued Other Interest calculated after the script has been run.
AccruedOtherInterestResolved Read-Only Returns the value of Accrued Other Interest to be charged.
AccruedOtherInterestSuspended Read-Only Is Other Interest currently suspended?
AdjustmentElementId The Id of the Element to charge any Adjustment to.
AdjustmentElementPk The primary key of the Element to charge any Adjustment to.
AdjustmentValue The Adjustment value, e.g. a small rounding write-off value.
AdjustmentValueResolved Read-Only Returns the Adjustment value, but only if the Adjustment Element is defined.
BalanceCurrent Read-Only The Balance of all posted Transactions for the Account.
BalanceDue The Balance Due to close the Account. (This value excludes the Payment Method Fee).
BalanceNet Read-Only The Net Balance of the Account, includes Accruals and Unposted values.
BankInterfaceServiceLogPk Read-Only The Primary Key of the Service Log created when processing the Bank Interface.
BankTransactionPk Read-Only The Primary Key of the Payment's Bank Transaction.
BankingDetails Read-Only The Banking Details, including the Payment Method.
CashRegisterId The Id of the Cash Register used for this Transaction.
CashRegisterPk The Primary Key of the Cash Register used for this Transaction.
CloseDate The date the Account is Closing.
CloseMethod The type of Close undertaking, i.e. the Close Method.
CloseMethodText The Close in its Text representation.
CloseNote A short Note regarding the Close.
ClosePending If true the Account's status is set to "Closed Pending" rather than "Closed".
ClosePendingReviewDate The date the "Closed Pending" status should be reviewed on.
Disbursements Read-Only Disbursement Recoveries.
FeeAllowChange Indicates whether the User can change the Fee charged.
FeeAvailable Read-Only
FeeChargeFee Indicates whether a Fee should be charged.
FeeElementId The Id of the Element to charge the Fee to.
FeeElementPk The primary key of the Element to charge the Fee to.
FeeNotes Notes to add to Fee transaction. If blank uses the Element's default Transaction Notes.
FeeValue The Fee value to be charged.
FeeValueOriginal Read-Only The Fee value originally calculated.
FeeValuePostScript Read-Only The Fee value calculated after the script has been run.
FeeValueResolved Read-Only Returns the Fee value to be charged, but only if the Fee Element is defined and the Fee is being charged.
FuturePayments Read-Only The value of Future expected Payments. Applicable to Loan Accounts, when ShowFuturePayments=True.
FuturePaymentsShow
FuturePaymentsShowResolved Read-Only
IsAutomaticClose Read-Only Determines if this Account Close is being run from within the Close Accounts wizard, i.e. the finAccountAutomaticClose object.
IsQuotation Read-Only Determines if this is a Quotation for an Account Close.
IsResidualValueApplicable Read-Only Indicates whether a Residual Value is applicable to this Account.
LossAllowChange Indicates whether the User can change the Loss value.
LossElementId The Id of the Element to charge the Loss to.
LossElementPk The primary key of the Element to charge the Loss to.
LossFormula Read-Only The Formula used in the Loss Formula.
LossFormulaText Read-Only The Formula used in the Loss Formula in its String representation.
LossMessageError If an error occurred when calculating the Loss this contains the error message.
LossMessageInformation Optional Information message generated during the Loss calculation.
LossValue The Loss value to be charged.
LossValueOriginal Read-Only The Loss value originally calculated.
LossValuePostScript Read-Only The Loss value calculated after the script has been run.
LossValueResolved Read-Only Returns the Loss value to be charged, but only if the Loss Element is defined.
Other1AllowChange Indicates whether the User can change the Other1 value.
Other1Available Read-Only Indicates whether the Other1 value is used.
Other1Charge Indicates whether a Other1 should be charged.
Other1Description Other1 description.
Other1ElementId The Id of the Element to charge the Other1 to.
Other1ElementPk The primary key of the Element to charge the Other1 to.
Other1Notes Notes to add to Other1 transaction. If blank uses the Element's default Transaction Notes.
Other1Value The Other1 value to be charged.
Other1ValuePostScript Read-Only The Other1 value calculated after the script has been run.
Other1ValueResolved Read-Only Returns the Other1 value to be charged, but only if the Other1 Element is defined and the Other1 is being charged.
Other2AllowChange Indicates whether the User can change the Other2 value.
Other2Available Read-Only Indicates whether the Other2 value is used.
Other2Charge Indicates whether a Other2 should be charged.
Other2Description Other2 description, used as a caption in the User Interface.
Other2ElementId The Id of the Element to charge the Other2 to.
Other2ElementPk The primary key of the Element to charge the Other2 to.
Other2Notes Notes to add to Other2 transaction. If blank uses the Element's default Transaction Notes.
Other2Value The Other2 value to be charged.
Other2ValuePostScript Read-Only The Other2 value calculated after the script has been run.
Other2ValueResolved Read-Only Returns the Other2 value to be charged, but only if the Other2 Element is defined and the Other2 is being charged.
PayMethodAccountName System Use Only Obsolete Payment Method's Bank Account Name.
PayMethodAccountNumber System Use Only Obsolete Payment Method's Bank Account/ Credit Card Number.
PayMethodAccountSortCode System Use Only Obsolete Payment Method's Bank Account Sort Code.
PayMethodBankBranchName System Use Only Obsolete Bank Branch Name.
PayMethodBankNameShort System Use Only Obsolete Short Bank Name.
PayMethodBankReference System Use Only Obsolete Payment Method's Bank Reference.
PayMethodCardExpiryDate System Use Only Obsolete The Payment Method's Credit Card Expiry Date.
PayMethodCardSecurityCode System Use Only Obsolete The Payment Method's Credit Card Security Code.
PaymentFeeAllowChange Indicates whether the User can change the Payment Fee.
PaymentFeeCharge Indicates whether the Payment Fee should be charged.
PaymentFeeElementId The Id of the Element to charge the Payment Fee to.
PaymentFeeElementPk The primary key of the Element to charge the Payment Fee to.
PaymentFeeValue The Payment Fee value to be charged.
PaymentFeeValueResolved Read-Only Returns the Payment Fee value to be charged, but only if the PaymentFee Element is defined and the Payment Fee is being charged.
PaymentMethodDescription Read-Only System Use Only Obsolete The Payment Method Description.
PaymentMethodId System Use Only Obsolete This is the Id of the Payment Method to use.
PaymentMethodPk System Use Only Obsolete This is the Primary Key of the Payment Method to use.
PaymentTypeCategory Read-Only System Use Only Obsolete The Payment Type Category.
PaymentValueResolved Read-Only Returns the Payment/Refund value and adds on the Payment Fee.
PrintCheque Indicates the Printed status of the Cheque.
PrintSummary Indicates whether a Summary (might include a Receipt) should be printed.
PrintSummaryResolved Read-Only Indicates whether a Summary (might include a Receipt) should be printed (but will only return 'True' if a Summary document exists for the Account Type).
RefinanceAccountTypeId The Id of of the Account Type to Refinance to if Refinancing to a New Account.
RefinanceAccountTypePk The primary key of the Account Type to Refinance to if Refinancing to a New Account.
RefinanceAccountTypePromotionId The Id of the Promotion if Refinancing to a New Account.
RefinanceAccountTypePromotionPk The primary key of the Promotion if Refinancing to a New Account.
RefinanceIntoAccountId The Id of the Account to Refinance into if Refinancing to an Existing Account.
RefinanceIntoAccountPk The primary key of the Account to Refinance into if Refinancing to an Existing Account.
RefinanceIntoCopySecurityStmtItems When Refinancing into an Existing Account, this option indicates whether to copy Security Statement Items from one Security Statement to another (the exact behaviour of this is determined by other options, e.g., the Register Status of the Security Statements).
RefinanceIntoDischargeSecurityStmt When Refinancing into an Existing Account and both Accounts have a Registered Security Statement, this option indicates whether to discharge the Security Statement that is not being kept as the Main Security Statement.
RefinanceIntoMainSecurityStmtIsFromRefinancedAccount When Refinancing into an Existing Account and both Accounts have a Registered Security Statement, this option indicates that the Main Security Statement (i.e., the one to link to the Account being Refinanced into) is the Security Statement currently attached to the Account being Refinanced.
RefinanceIntoSecurityStmtWarning The Warning that was displayed to the User in the User Interface regarding Security Statement Changes that would be made.
RefinanceOption The Refinance option.
RefinanceOptionText The Refinance Option in its Text representation.
RefinancedAccountId Read-Only The Id of the Refinanced Account created during the ExecuteCommit method or of an existing Account if Refinancing into an Existing Account.
RefinancedAccountPk Read-Only The primary key of the Refinanced Account created during the ExecuteCommit method or of an existing Account if Refinancing into an Existing Account.
RequiresCalculation Read-Only Returns True if the last Calculate failed, or the Account, Close Date or Method have changed since the last Calculate.
ResidualAllowChange Indicates whether the User can change the Residual Value to credit.
ResidualElementId The Id of the Element to credit the Residual Value to.
ResidualElementPk The primary key of the Element to credit the Residual Value to.
ResidualValue The Residual Value to credit.
ResidualValueCredit Indicates whether to credit the Residual value.
ResidualValueOriginal Read-Only The Residual value from the Account.
ResidualValuePostScript Read-Only The Residual value from the Account after the script has been run.
ResidualValueResolved Read-Only Returns the Residual value to be credited, but only if the Residual Element is defined and the Residual is being credited.
ScriptId Read-Only The Script used in Calculations.
ScriptPk Read-Only The primary key of the Script used in Calculations.
SendBankInterface Indicates whether, if applicable, the Bank Transaction is automatically processed at the end of ExecuteCommit.
Summary Read-Only Summary of the Account's current Balance, including Credits to rebate.
SupportsPrintSummary Read-Only Indicates whether a Summary can be printed; i.e. the Summary document exists for the Account Type.
Tag The Tag property can be used to attach another value or object to this object.
TransactionNotes Transaction Notes.
TransactionReference Transaction Reference.
TransactionTypeDescription Read-Only
TransactionTypeId The Id of the Transaction Type for this Payment.
TransactionTypePk The primary key of the Transaction Type for this Payment.
UnpostedDefaultFees The value of Unposted Default Fee Transactions.
UnpostedDefaultFeesAvailable Read-Only
UnpostedDefaultFeesCharge
UnpostedDefaultFeesOriginal Read-Only The value of Unposted Default Fees that was originally calculated.
UnpostedDefaultFeesPostScript Read-Only The value of Unposted Default Fees that was calculated after the script was run.
UnpostedDefaultFeesResolved Read-Only Returns the value of Unposted Default Fees to be charged.
UnpostedDefaultFeesSuspended Read-Only Are Unposted Default Fees currently suspended?
UnpostedFacilityFees The value of Unposted Facility Fee Transactions.
UnpostedFacilityFeesAvailable Read-Only
UnpostedFacilityFeesCharge
UnpostedFacilityFeesOriginal Read-Only The value of Unposted Facility Fees that was originally calculated.
UnpostedFacilityFeesPostScript Read-Only The value of Unposted Facility Fees that was calculated after the script was run.
UnpostedFacilityFeesResolved Read-Only Returns the value of Unposted Facility Fees to be charged.
UnpostedFacilityFeesSuspended Read-Only Are Unposted Facility Fees currently suspended?
UnpostedOverLimitFees The value of Unposted Over Limit Fee Transactions.
UnpostedOverLimitFeesAvailable Read-Only
UnpostedOverLimitFeesCharge
UnpostedOverLimitFeesOriginal Read-Only The value of Unposted Over Limit Fees that was originally calculated.
UnpostedOverLimitFeesPostScript Read-Only The value of Unposted Over Limit Fees that was calculated after the script was run.
UnpostedOverLimitFeesResolved Read-Only Returns the value of Standard Transactions to be charged.
UnpostedOverLimitFeesSuspended Read-Only Are Unposted Over Limit Fees currently suspended?
UnpostedStandardTransactions Read-Only The value of Unposted Transactions.
UnpostedStandardTransactionsCharge
UnpostedStandardTransactionsResolved Read-Only Returns the value of Standard Transactions to be charged.
UnpostedStandardTransactionsSuspended Read-Only Are Unposted Standard Transactions currently suspended?
WithholdingTaxRate The Withholding Tax Rate.
WithholdingTaxResidentStatus The Withholding Tax Resident Status.
WithholdingTaxResidentStatusShortText Read-Only The Withholding Tax Resident Status in its shortened string representation.
WithholdingTaxResidentStatusText The Withholding Tax Resident Status in its string representation.
WithholdingTaxValue The Withholding Tax Value.
WithholdingTaxValueOriginal Read-Only The value of Withholding Tax that was originally calculated.
WithholdingTaxValuePostScript Read-Only The value of Withholding Tax calculated after the script has been run.
WithholdingTaxValueResolved Read-Only Returns the value of Withholding Tax on the Accrued Interest to be deducted.
Namespace:
Intersoft.finSupport6
Assembly:
finSupport6, Version=6.0.3
Target Framework:
.NET 9.0