finClient Class

Represents a Client.
Implements I_ISDirty, I_ISObjectName, I_ISSummaryText, I_finExtendedAuditInformation, I_finSummaryPages, I_finAIQuestionable
Used in sample: Loading and Updating a Client

Methods

Name Description
AccountsLoad Loads the Accounts collection.
AccountsRefresh Forces the Accounts collection to be reloaded from the database the next time it is accessed.
AddresseeNameDefault Returns the default Addressee Name based upon the Global settings default.
AkasLoad Loads the Akas collection.
AkasRefresh Forces the Akas collection to be reloaded from the database the next time it is accessed.
AuditItemsLoad Loads the Audit Items collection.
AuditItemsRefresh Forces the Audit Items collection to be reloaded from the database the next time it is accessed.
BankAccountsLoad Loads the Bank Accounts collection.
BankAccountsRefresh Forces the BankAccounts collection to be reloaded from the database the next time it is accessed.
CanCreditBureauMonitorBeStarted Indicates whether Monitoring for the Client can be started.
CanCreditBureauMonitorBeStopped Indicates whether Monitoring for the Client can be stopped.
CanDelete Indicates whether the Client can be deleted.
CanPerformBankAccountEnquiry Indicates whether a Bank Account Enquiry can be run for this Client.
CanPerformCreditEnquiry Indicates whether a Credit Enquiry can be run for this Client.
CanUpdate Indicates whether the Client can be updated.
Clear Clears this object and sets all of its properties to their defaults.
ClientGroupIdSet Sets the Client Group, applying default Communication Settings.
ClientTypeIdSet Sets the Client Type, applying default Tax settings.
ContactAddressesLoad Loads the Contact Addresses collection.
ContactAddressesRefresh Forces the Contact Addresess collection to be reloaded from the database the next time it is accessed.
ContactMethodsLoad Loads the Contact Methods collection.
ContactMethodsRefresh Forces the Contact Methods collection to be reloaded from the database the next time it is accessed.
Delete Deletes this record.
DocumentFilesLoad Loads the DocumentFiles collection.
DocumentFilesRefresh Forces the DocumentFiles collection to be reloaded from the database/file system the next time it is accessed.
DocumentManagerAddFile System Use Only Obsolete Add a File to the Document Manager folder.
DocumentManagerFolderCreate System Use Only Obsolete Create the Document Manager Folder if it does not exist.
DocumentManagerFolderExists System Use Only Obsolete Check to see if the Document Manager Folder exists.
Duplicate Duplicates this object.
EmploymentsLoad Loads the Employments collection.
EmploymentsRefresh Forces the Employments collection to be reloaded from the database the next time it is accessed.
ExecuteIdentificationDecisionCard Execute the Decision Card defined by this Client's Client Group for scoring Client Identification.
FilesLoad System Use Only Obsolete Loads the Files collection.
FilesRefresh System Use Only Obsolete Forces the Files collection to be reloaded from the database/file system the next time it is accessed.
FromXmlString Populates object from an XML string.
GetAIQuestionableTextToolCallableDocument
GetAISummaryQuestionableText
GetActiveCreditBureauMonitorLog Gets the active Credit Bureau Monitor for the Client.
GetDocumentAllowedViaEmail Indicates whether the Client should receive a Document via Email, based upon the Document and the Client's Communication Settings.
GetEvents
GetFullName Gets the Full Name. For an Organisation the Company Name, unless personActing is True.
GetIdentificationDecisionOutcome Retrieves the latest Identification Decision Outcome.
GetImageDataUrl Get the Client Image as a Data URL/URI (for use in HTML pages).
GetIncompleteAccountsCount Get a Count of Incomplete Accounts for this Client.
GetIncompleteWorkflowsCount Gets a count of Incomplete Workflows for this Client.
GetLatestBankAccountEnquiry Gets the latest Bank Account Enquiry for the Client matching the filters.
GetLatestCreditEnquiry Gets the latest Credit Enquiry for the Client matching the filters.
GetLinkedRecordDetails Get details (Id and Description) or the record that this Client is linked to.
GetLogCountIncomplete A Count of Incomplete Logs.
GetLogCountUnreadWebMail A Count of Unread Web Mail Logs.
GetObjectName
GetPendingUpdateRequests Retrieves Pending Update Request Values for this Client.
GetRecordActionAvailabiltyInformation
GetRelatedAccountsSQL
GetSearch Retrieves User Defined Search data.
GetSummaryText Get Summary Text.
GetUserDataByIndex Retrieves User Defined Data by its Index.
GetWarnings Get Warnings.
GetWebPreviousLoginDate System Use Only Obsolete
GetWebPreviousLoginUtcDate Get the UTC Date and Time of the previous successful Login from the ISAuditLog table.
HasBankAccountEnquiryInProgress Returns True if there is a Pending "In Progress" Bank Account Enquiry.
HasLogWarnings Checks to see if there are any incomplete Logs with a Log Severity action.
IdentificationItemsLoad Loads the Identification Items collection.
IdentificationItemsRefresh Forces the Identification Items collection to be reloaded from the database the next time it is accessed.
ImageFileAdd Add an Image File to the Document Manager and associate it with this Client record.
IsCreditBureauMonitored Returns True if the Client is monitored via a Credit Bureau.
Load Loads a record from the database.
LoadExternalId Loads a record from the database using the External Id.
LoadPk Loads a record from the database.
LoadWebUserId Loads a record from the database using the External Id.
LogsLoad Loads the Logs collection.
LogsRefresh Forces the Logs collection to be reloaded from the database the next time it is accessed.
Refresh Refreshes this object from the database.
SalutationDefault Returns the default Salutation based upon the Global settings default.
Save Save this record.
SecurityStmtsLoad Loads the SecurityStmts collection.
SecurityStmtsRefresh Forces the SecurityStmts collection to be reloaded from the database the next time it is accessed.
SetPepStatusFromCreditEnquiry Set the PEP Status from the Credit Bureau Enquiry response PEP Status.
SetSearch Sets User Defined Search data.
SetUserDataByIndex Sets User Defined Data by its Index.
StatisticsRefresh Executes the Statistics Refresh script for a Client Statistics Set.
StatisticsSetsLoad Loads the Client Statistics Sets collection.
StatisticsSetsRefresh Forces the Client Statistics Sets collection to be reloaded from the database the next time it is accessed.
SummaryPagesLoad Loads the Summary Pages collection.
SummaryPagesRefresh Forces the Summary Pages collection to be rebuilt the next time it is accessed.
TaxCertificatesLoad Loads the Tax Certificates collection.
TaxCertificatesRefresh Forces the Tax Certificates collection to be reloaded from the database the next time it is accessed.
ToXmlString Persists Client to an XML string.
TransactionsLoad Loads the Transactions collection.
TransactionsRefresh Forces the Transactions collection to be reloaded from the database the next time it is accessed.
UserDataInitialiseFromParameterSet Initialise User Data from a Parameter Set, i.e., create User Data entries and defaults.
UserDataWebInitialiseFromParameterSet Initialise Web User Data from a Parameter Set, i.e., create Web User Data entries and defaults.
VideoFileAdd Add an Video File to the Document Manager and associate it with this Client record.
VisualFileAdd Adds a Client Image or Client Video based upon the file type.
WebPasswordChangeRequired Indicates if the Client's Web Password is required to be changed.
WebPasswordSet Set the Web Password.
WorkflowsLoad Loads the Workflows collection.
WorkflowsRefresh Forces the Workflows collection to be reloaded from the database the next time it is accessed.

Properties

Name Description
AccountAppApplicant The Account Application Applicant that this Client has been generated from. This is not saved to the database and is only set when an unsaved Account is generated from an Account Application.
AccountAppApplicantPk Read-Only The primary key of the Account Application Applicant that this Client has been generated from. This is not saved to the database and is only set when an unsaved Account is generated from an Account Application.
Accounts Read-Only A collection of Accounts.
AccountsLoaded Read-Only Indicates whether the Accounts collection has been loaded.
Active Indicates whether this record is Active.
AddresseeName The Name to use when Addressing mail.
AddresseeNameResolved Read-Only System Use Only Obsolete The Name to use when Addressing mail.
AddresseeNameResolved2 Read-Only The Resolved Name to use when Addressing mail.
Age Read-Only The Client's Age as at today as calculated from their Date of Birth.
Akas Read-Only A collection of AKA Names.
AkasChanged Read-Only Indicates whether the Akas collection has been loaded and has had changes made to it.
AkasLoaded Read-Only Indicates whether the Akas collection has been loaded.
AlertMessage Alert Message.
AuditItems Read-Only A collection of Audit Items.
AuditItemsLoaded Read-Only Indicates whether the Audit Items collection has been loaded.
BankAccounts Read-Only A collection of Bank Account details.
BankAccountsChanged Read-Only Indicates whether the Bank Accounts collection has been loaded and has had changes made to it.
BankAccountsLoaded Read-Only Indicates whether the Bank Accounts collection has been loaded.
Branch Read-Only The Client's Branch.
BranchId The Id of this Client's Branch.
BranchPk The primary key of this Client's Branch.
BusinessNumber The Business Number for a Business Client.
ClientClass Read-Only The Client Class.
ClientGroup Read-Only The Client's Client Group.
ClientGroupId The Id of this Client's Client Group.
ClientGroupPk The primary key of this Client's Client Group.
ClientGroupUseStatistics Read-Only Returns the Client Group 'Use Statistics' value depending on whether this is an Individual or Company Client.
ClientId The Id of this Client.
ClientManagerUser Read-Only The User who Managers this Client.
ClientManagerUserId The Id of the User who Manages this Client.
ClientManagerUserPk The primary key of the User who Manages this Client.
ClientPortalData Read-Only System Use Only Client-Portal-related data.
ClientType Read-Only The Client's Client Type.
ClientTypeId The Id of this Client's Client Type.
ClientTypePk The primary key of this Client's Client Type.
CommencementDate The Commencement Date of an Organisation Client.
CommunicationFlags Other Communication Flags.
CommunicationGeneral Indicates whether this Client wishes to receive General Communication.
CommunicationGeneralEmail Indicates whether this Client wishes to receive General Communication via Email.
CommunicationGeneralEmailResolved Read-Only The Resolved CommunicationGeneralEmail
CommunicationGeneralLetter Indicates whether this Client wishes to receive General Communication via Printed Letter.
CommunicationGeneralLetterResolved Read-Only The Resolved CommunicationGeneralLetter
CommunicationGeneralPhoneVoice Indicates whether this Client wishes to receive General Communication via a Voice Phone call.
CommunicationGeneralPhoneVoiceResolved Read-Only The Resolved CommunicationGeneralPhoneVoice
CommunicationGeneralSms Indicates whether this Client wishes to receive General Communication via SMS.
CommunicationGeneralSmsResolved Read-Only The Resolved CommunicationGeneralSms
CommunicationMarketing Indicates whether this Client wishes to receive Marketing Communication.
CommunicationMarketingEmail Indicates whether this Client wishes to receive Marketing Communication via Email.
CommunicationMarketingEmailResolved Read-Only The Resolved CommunicationMarketingEmail
CommunicationMarketingLetter Indicates whether this Client wishes to receive Marketing Communication via Printed Letter.
CommunicationMarketingLetterResolved Read-Only The Resolved CommunicationMarketingLetter
CommunicationMarketingPhoneVoice Indicates whether this Client wishes to receive Marketing Communication via a Voice Phone call.
CommunicationMarketingPhoneVoiceResolved Read-Only The Resolved CommunicationMarketingPhoneVoice
CommunicationMarketingSms Indicates whether this Client wishes to receive Marketing Communication via SMS.
CommunicationMarketingSmsResolved Read-Only The Resolved CommunicationMarketingSms
CommunicationOther1 Other Communication flag 1.
CommunicationOther1Resolved Read-Only The Resolved CommunicationOther1
CommunicationOther2 Other Communication flag 2.
CommunicationOther2Resolved Read-Only The Resolved CommunicationOther2
CommunicationOther3 Other Communication flag 3.
CommunicationOther3Resolved Read-Only The Resolved CommunicationOther3
CommunicationOther4 Other Communication flag 4.
CommunicationOther4Resolved Read-Only The Resolved CommunicationOther4
ContactAddresses Read-Only A collection of Contact Addresses.
ContactAddressesChanged Read-Only Indicates whether the Contact Addresses collection has been loaded and has had changes made to it.
ContactAddressesLoaded Read-Only Indicates whether the Contact Addresses collection has been loaded.
ContactMethods Read-Only A collection of Contacts Methods.
ContactMethodsChanged Read-Only Indicates whether the Contact Methods collection has been loaded and has had changes made to it.
ContactMethodsLoaded Read-Only Indicates whether the Contact Methods collection has been loaded.
CreatedDate Read-Only The Local date and time this record was created.
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.
CreditRating The Client's Credit Rating.
CrossReference The Client's Cross Reference.
DateOfBirth The Date of Birth for an Individual Client or a Sole Trader.
DateOfDeath The Date of Death for an Individual Client or a Sole Trader.
DateReview The Review Date for an Individual Client.
Dependants The Dependants for an Individual Client.
DocumentFiles Read-Only A collection of Document Manager Files.
DocumentFilesLoaded Read-Only Indicates whether the DocumentFiles collection has been loaded.
DocumentManagerFolderName Read-Only System Use Only Obsolete The Document Manager folder for this Client.
Employments Read-Only A collection of Employments.
EmploymentsChanged Read-Only Indicates whether the Employments collection has been loaded and has had changes made to it.
EmploymentsLoaded Read-Only Indicates whether the Employments collection has been loaded.
Entity Read-Only The Client's Entity (derived from the Branch).
EntityId Read-Only The Id of this Client's Entity (derived from the Branch).
EntityPk Read-Only The primary key of this Client's Entity (derived from the Branch).
ExemptionCertificate The Withholding Tax Exemption Certificate number.
ExemptionExpiryDate The Date on which the Withholding Tax Exemption Certificate Expires.
ExemptionIssueDate The Date on which the Withholding Tax Exemption Certificate was Issued.
ExternalId The Id of this Client in an External application.
Files Read-Only System Use Only Obsolete A collection of Document Manager Files.
FilesChanged Read-Only System Use Only Indicates whether the Files collection has been loaded and has had changes made to it.
FilesLoaded Read-Only System Use Only Obsolete Indicates whether the Files collection has been loaded.
FirstName The First Name for an Individual Client or Sole Trader and the Person Acting for an Organisation.
Gender The Gender for an Individual Client.
GenderText The Gender in its String representation.
GetWTaxRate Read-Only
GetWTaxWarnings Read-Only
GstExempt Indicates whether this Client is Exempt from paying GST.
GstNumber The GST Number for an Organisation Client.
HasIdentificationDecisionCard Read-Only Indicates whether this Client's Client Group defines a Decision Card for scoring Client Identification.
HasPersonActing Read-Only Indicates whether there is a Person Acting for this organisation Client.
HasWebPassword Read-Only Indicates whether a Web Password has been entered for this Client.
IdentificationItems Read-Only A collection of Identification Items.
IdentificationItemsChanged Read-Only Indicates whether the Identification Items collection has been loaded and has had changes made to it.
IdentificationItemsLoaded Read-Only Indicates whether the Identification Items collection has been loaded.
ImageFileName The File Name of a Client Image.
ImageFileNameResolved Read-Only Returns the Image File Name resolved into a fully qualified File Name.
IndividualNumber The Individual Number.
IndustryCode The Industry Code.
IndustryCodeDescription Read-Only
IsDirty Read-Only Indicates whether this object has been modified since being created, loaded or refreshed.
IsIncorporated Read-Only Indicates whether this Organisation Client is Incorporated.
IsIndividual Read-Only Indicates whether this Client is an Individual.
IsIndividualDeceased Read-Only Indicates whether this Client is a Deceased Individual.
IsIndividualOrSoleTrader Read-Only Indicates whether this Client is an Individual or Sole Trader.
IsNew Read-Only Indicates whether this is a new record.
IsOrganisation Read-Only Indicates whether this Client is an Organisation.
IsSoleTrader Read-Only Indicates whether this Organisation Client is a Sole Trader.
IsWebLockedOut Read-Only Indicates whether this Client's Web Access is Locked Out due to too many failed Logins.
IsWebLockedOutResolved Read-Only Indicates whether this Client's Web Access is Locked Out due to too many failed Logins AND has not yet reached the auto-unlock period defined under Global Settings.
IsWithholdingTaxRateDeclared Read-Only Indicates whether this Client's Withholding Tax Rate should use the Declared Rate.
JobTitle The Job Title for an Organisation Clients Person Acting.
LastName The Last Name for an Individual Client or Sole Trader and the Person Acting for an Organisation.
LegalName The Legal Name for an Organisation Client.
LegalNameResolved Read-Only The Legal Name for an Organisation Client or the Client Name if no Legal Name is specified.
Logs Read-Only A collection of Logs.
LogsLoaded Read-Only Indicates whether the Logs collection has been loaded.
MaritalStatus The Marital Status for an Individual Client.
MiddleNames The Middle Names for an Individual Client or Sole Trader and the Person Acting for an Organisation.
MultiFactorAuthenticationPreferredMethod The Preferred Multi-Factor Authentication Method (MFA) to use.
MultiFactorAuthenticationPreferredMethodText The Preferred Multi-Factor Authentication Method in its String representation.
Name The Name of this Client.
NameFull Read-Only System Use Only Obsolete Gets the Full Name. For an Organisation the Company Name, unless personActing is True.
NominatedBankAccount Read-Only If a nominated Bank Account has been set, returns the Client Bank Account.
NominatedBankAccountPk The Nominated Bank Account.
Notes Client Notes.
Occupation The Occupation for an Individual Client or a Sole Trader.
OrganisationNumber The Organisation Number for an Incorporated Organisation Client.
Parent Read-Only This Client's Parent object.
ParentBranch Read-Only If the Client's Special Type is "Branch", returns the Parent Branch - otherwise returns Nothing.
ParentExternalParty Read-Only If the Client's Special Type is "ExternalParty", returns the Parent External Party - otherwise returns Nothing.
ParentExternalPartyPk Read-Only If the Client's Special Type is "ExternalParty", returns the Primary Key of the Parent External Party.
ParentExternalPartyRO Read-Only If the Client's Special Type is "ExternalParty", returns the Parent External Party from the External Party Global Collection - otherwise returns Nothing.
PassCode Challenge Pass Code for accessing the Client. Used to identify a person before providing information regarding the Client.
Password System Use Only Obsolete
PepStatus The PEP Status.
PepStatusDate The date of the PEP Status.
PepStatusText The PEP Status in its String representation.
Pk Read-Only This record's primary key.
PreferredName The Preferred Name for an Individual Client or Sole Trader and the Person Acting for an Organisation.
PreferredNameResolved Read-Only The Preferred Name for an Individual Client, or if Blank the Clients's First Name.
ResidencyStatus The ResidencyStatus Status for an Individual Client.
Resident Indicates whether this Client is a Resident for Tax purposes.
ResidentialStatus The Residential Status for an Individual Client.
Salutation The Salutation for letters.
SalutationResolved Read-Only The Salutation for letters.
Search System Use Only Obsolete User Defined Search data.
SecurityStmts Read-Only A collection of SecurityStmts.
SecurityStmtsLoaded Read-Only Indicates whether the SecurityStmts collection has been loaded.
SpecialType A Special Type that may apply to this Client.
SpecialTypeText Read-Only The Special Type in its String representation.
StatisticsSets Read-Only A collection of Client Statistics Sets.
StatisticsSetsChanged Read-Only Indicates whether the Statistics Sets collection has been loaded and has had changes made to it.
StatisticsSetsLoaded Read-Only Indicates whether the Statistics Sets collection has been loaded.
StatisticsSetsSupportsAssetsAndLiabilities Read-Only Indicates whether this Client's Group is applicable for the "Assets and Liabilities" Statistic Types.
StatisticsSetsSupportsIncomeAndExpenses Read-Only Indicates whether this Client's Group is applicable for the "Income and Expenses" Statistic Types.
Status The Client's Status.
StatusText The Status in its String representation.
SummaryPages Read-Only A collection of Summary Pages.
SummaryPagesLoaded Read-Only Indicates whether the Summary Pages collection has been loaded.
Tag The Tag property can be used to attach another value or object to this object.
TaxCategoryId The Id of this Client's Tax Category.
TaxCategoryPk The primary key of this Client's Tax Category.
TaxCertificates Read-Only A collection of Tax Certificates for the Client.
TaxCertificatesLoaded Read-Only Indicates whether the Tax Certificates collection has been loaded.
TaxCountry The Country for GST Taxation.
TaxForeignReference A foreign Tax Reference if the Client is Non-Resident.
TaxNumber The Tax Number for the Client.
TaxNumberSimple Read-Only The Tax Number, with any spaces or dashes removed.
Timestamp Read-Only This record's Timestamp.
Title The Title for an Individual Client.
Transactions Read-Only A collection of Bank Transactions linked to Accounts where this Client is an Owner.
TransactionsLoaded Read-Only Indicates whether the Transactions collection has been loaded.
UpdatedDate Read-Only The Local date and time this record was last updated.
UpdatedUserPk Read-Only The primary key of the User that last updated this record.
UpdatedUtcDate Read-Only The UTC date and time this record was last updated.
User Indexed User Defined data. This data is stored in both the UserData Key/ Value List and as separate queryable fields in the Database.
UserData Read-Only User Defined data.
UserDataWeb Read-Only User Defined Web data.
WebAccess Indicates whether this Client has Web Access.
WebFailedLoginCount Read-Only The Number of Failed Web Login attempts since WebFirstFailedLoginDate.
WebFailedLoginDate Read-Only The Local date and time of the first failed Web login.
WebFailedLoginUtcDate Read-Only The UTC date and time of the first failed Web login.
WebLastLoginDate Read-Only The Local date and time of the last successful Web login.
WebLastLoginUtcDate Read-Only The UTC date and time of the last successful Web login.
WebLockedOutDate Read-Only The Local date and time of the first failed Web login attempt.
WebLockedOutUtcDate Read-Only The UTC date and time of the first failed Web login attempt.
WebPasswordDatabaseDate Read-Only The Database Date the Web Password was set.
WebPasswordForceChange Indicates whether Portals (or other external applications) should force the Client to change their Password.
WebPasswordLocalDate Read-Only The Local Date the Web Password was set.
WebPasswordUtcDate Read-Only The UTC Date the Web Password was set.
WebUserId The Web User Id if different from the Client Id.
Workflows Read-Only A collection of Workflows.
WorkflowsLoaded Read-Only Indicates whether the Workflows collection has been loaded.
Namespace:
Intersoft.finSupport6
Assembly:
finSupport6, Version=6.0.3
Target Framework:
.NET 9.0