finAccountPayArrangementAdd Class

Functionality to make a Payment Arrangement for an Account.

Methods

Name Description
AccountLoad Loads the Account.
AccountLoadFromUpdateRequest Loads the Account and pre-populates the Payment Arrangement from an Update Request.
AccountLoadPk Load the Account.
AddInterestRateChange
AddWithdrawal
Calculate Updates Calculations.
CanSendDocument Check to see whether the Account can be sent the 'Advice' Document, e.g., that at least one Account Client has an Email Address when attempting to send an Email Document.
Clear Clears this object and sets all of its properties to their defaults.
ExecuteCommit
PromisesAdd Adds Promises to Overriding Payment Schedule based upon the parameters specified.
PromisesAddWithScript Adds Promises to Overriding Payment Schedule based upon the parameters specified.
PromisesClear
RegularPaymentsCreate Creates Regular Payments in the collection of Overriding Payments.
Reset

Properties

Name Description
Account Read-Only The Account.
AccountPayArrangePk Read-Only The Primary Key of the Account's Payment Arrangement record created.
ArrangementByWhom Who made the Payment Arrangement.
ArrangementDate The date the Payment Arrangement was made.
ArrangementReason Reason for the Payment Arrangement.
ArrangementType The Type of Payment Arrangement.
Calculation Read-Only The Calculation and future Schedule including revised Payments and Fee.
ComparisonRate Read-Only Returns the Comparison Rate for the Account.
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.
DocumentLogs Read-Only A List of Account Logs generated as a result of creating a Document within the ExecuteCommit method.
FeeAllowChange Indicates whether the User can change to Fee charged.
FeeCharge 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.
FeeValue The Fee value to be charged.
FeeValueResolved Read-Only Returns the Fee value to be charged, but only if the Fee Element is defined and the Fee is being charged.
HasAccountInterestRateChange Read-Only Returns True if this Payment Arrangement is linked to an Interest Rate Change.
HasAccountWithdrawal Read-Only Returns True if this Payment Arrangement is linked to a Withdrawal.
LogActionDate The Log Action Date (in Local time for this Windows computer).
LogActionDbDate The Log Action Date (in the Database Time Zone). Setting the Log Action Date will update the Time Zone to the Database Time Zone.
LogActionTimeZone Read-Only
LogActionTimeZoneDescription Read-Only
LogActionTimeZoneId The Id of the Time Zone associated with the Log Action Date.
LogActionTzDate The Log Action Date (in the Time Zone defined by the LogActionTimeZone property or, if this is undefined, the Database Time Zone defined under Global Settings).
LogActionUtcDate The Log Action Date in UTC.
LogCreate Indicates whether to create an Account Log.
LogDate The Log Date (in Local time for this Windows computer).
LogDbDate The Log Date (in the Database Time Zone). Setting the Log Date will update the Time Zone to the Database Time Zone.
LogNotes The Notes regarding the change, e.g. the reason for the change.
LogSeverityId The Id of the Log's Log Severity.
LogSeverityPk The primary key of the Log's Severity.
LogSubject The Log Subject.
LogTimeZone Read-Only The Time Zone associated with the Log Date.
LogTimeZoneDescription Read-Only
LogTimeZoneId The Id of the Time Zone associated with the Log Date.
LogTzDate The Log Date (in the Time Zone defined by the LogTimeZone property or, if this is undefined, the Database Time Zone defined under Global Settings).
LogUtcDate The Log Date in UTC.
OverdueHold Indicates whether the Overdue value is cleared.
OverdueHoldVisible Indicates whether the User Interface should show the OverdueHold option.
PaymentMethodIsDirectDebit Read-Only Indicates whether the Account's Incoming Payment Method is a Direct Debit.
PrintAdvice Indicates whether a Payment Arrangement advice should be printed.
PromiseTotalOverride Indicates whether the User Interface should override the normal Overdue total with PromiseTotalOverrideValue.
PromiseTotalOverrideValue The overriding Promise Total if PromiseTotalOverride is True.
Source Read-Only
UpdateCreditBureauDefaults Indicates whether to update any active Credit Bureau Defaults to indicate that a Payment Arrangement is in place, e.g., update the Default Status to 'Scheme of Arrangement' or whatever to relevant code is for a particular Credit Bureau Service.
UpdateMaturityDateAndContractualPayments Indicates whether to update Contracted Payments for a Fixed Term Floating Rate Loan to this Payment Arrangement.
UpdateMaturityDateAndContractualPaymentsResolved Read-Only Indicates whether to update Contracted Payments for a Fixed Term Floating Rate Loan to this Payment Arrangement.
UpdateMaturityDateAndContractualPaymentsVisible Indicates whether the "Update Maturity Date and Contractual Payments?" option in the Payment Arrangement wizard should be shown.
UserStatus User defined Status.
WorkflowId The Id of this Payment Arrangement's Workflow.
WorkflowItemPk The primary key of the Workflow Item that this Payment Arrangement links to.
WorkflowPk The primary key of the Workflow to link to.
Namespace:
Intersoft.finSupport6
Assembly:
finSupport6, Version=6.0.3
Target Framework:
.NET 9.0