finAccountAppApplicant Class

Represents an Account Application Applicant.
Implements I_ISDirty, I_ISObjectName

Methods

Name Description
AddresseeNameDefault Returns the default Addressee Name based upon the Global settings default.
AddresseeResolved The Name to use when Addressing mail.
Clear Clear all details except to the Key, KeyLocked, AccountRolePk, AccountRoleJoint and Used properties unless clearAll is True.
CreateClient Create an unsaved Client object.
GetAddressForLetters Get the Address for use in Letters, e.g. Word VBA templates.
GetClientQuickSearchQueries Get a list of text queries that can be used to attempt to locate a Client for this Applicant using the 'Quick Search' facility.
GetClientQuickSearchQuery Get a text query that can be used to attempt to locate a Client for this Applicant using the 'Quick Search' facility.
GetFullName Gets the Full Name. For an Organisation the Company Name, unless personActing is True.
GetImageBinaryData System Use Only Obsolete
GetObjectName
GetUserDataByIndex Retrieves User Defined Data by its Index.
GetUserDateByIndex Retrieves User Defined "Date" Data by its index.
GetUserDecimalByIndex Retrieves User Defined "Decimal" Data by its index.
GetUserIntegerByIndex Retrieves User Defined "Integer" Data by its index.
ImageFileAdd Add an Image File to the Document Manager and associate it with this Applicant record.
SalutationDefault Returns the default Salutation based upon the Global settings default.
SalutationResolved The Salutation to use on correspondence.
SetUserDataByIndex Sets User Defined Data by its Index.
SetUserDateByIndex Sets User Defined "Date" Data by its index.
SetUserDecimalByIndex Sets User Defined "Decimal" Data by its index.
SetUserIntegerByIndex Sets User Defined "Integer" Data by its index.
ShouldSendDocument Check to see if this Applicant should receive an Account Application Document.
UpdateFromClient Update Applicant from Client.
UpdateFromClientId Update Applicant from Client.

Properties

Name Description
AccountApp Read-Only The parent Account Application object.
AccountAppApplicants Read-Only The parent Account Applicants collection.
AccountHidden When converted to an Account, does this Client have rights to view the Account?
AccountRole Read-Only The Account Role or Nothing.
AccountRoleId The Id of the Account Role.
AccountRoleJoint Determines if the Applicant is a Joint Role with the previous Applicant.
AccountRoleJointResolved Read-Only Indicates whether this Applicant is a Joint Role with the previous Applicant - will always return False is the first "Used" Applicant for the Application.
AccountRolePk The Account Role's primary key.
AccountRoleResolvedId Read-Only The Id of the Account Role to use when creating an Account Client record.
AccountRoleResolvedPk Read-Only The primary key of the Account Role to use when creating an Account Client record.
AccountRoleType Read-Only The Account Role Type for this Applicant based on the Account Role.
AccountSignatory When converted to an Account, does this Client have signing authority on the Account?
AddressPhysical Read-Only Physical Address details.
AddressPhysicalIsPostal Indicates whether the Physical Address is the same as the Postal Address.
AddressPhysicalPk The primary key of the Client Contact Address that the Physical Address created.
AddressPhysicalPkOriginal The primary key of the Client Contact Address that the Physical Address was loaded from.
AddressPostal Read-Only Postal Address details.
AddressPostalPk The primary key of the Client Contact Address that the Postal Address created.
AddressPostalPkOriginal The primary key of the Client Contact Address that the Postal Address was loaded from.
AddresseeName The Name to use when Addressing mail.
AddresseeNameResolved Read-Only The Resolved Name to use when Addressing mail.
Age Read-Only The Age in years of the Applicant as at the Date Quoted specified on the Application or today's date if no Date Quoted is specified.
BusinessNumber The Business Number for a Business Applicant.
ClientGroupId The Id of the Client Group to use when creating a new Client record.
ClientGroupPk The primary key of the Client Group to use when creating a new Client record.
ClientGroupResolvedId Read-Only The Id of the Client Group to use when creating a new Client record.
ClientGroupResolvedPk Read-Only The primary key of the Client Group to use when creating a new Client record.
ClientId The Id of the Client to which this Applicant relates and the Client that will be updated from this Applicant.
ClientPk The primary key of the Client to which this Applicant relates and the Client that will be updated from this Applicant.
ClientTypeId The Id of the Client Type to use when creating a new Client record.
ClientTypePk The primary key of the Client Type to use when creating a new Client record.
ClientTypeResolvedId Read-Only The Id of the Client Type to use when creating a new Client record.
ClientTypeResolvedPk Read-Only The primary key of the Client Type to use when creating a new Client record.
CommencementDate The Commencement Date of an Organisation Client.
ContactEmail The Contact Email Address for this Applicant.
ContactEmailPk The primary key of the Client Contact Method that the Email Address created.
ContactEmailPkOriginal The primary key of the Client Contact Method that the Email Address was loaded from.
ContactFacsimile The Contact Facsimile Number for this Applicant.
ContactFacsimilePk The primary key of the Client Contact Method that the Facsimile Number created.
ContactFacsimilePkOriginal The primary key of the Client Contact Method that the Facsimile Number was loaded from.
ContactMobile The Contact Mobile Phone Number for this Applicant.
ContactMobilePk The primary key of the Client Contact Method that the Mobile Phone Number created.
ContactMobilePkOriginal The primary key of the Client Contact Method that the Mobile Phone Number was loaded from.
ContactPhone The Contact Phone Number for this Applicant.
ContactPhonePk The primary key of the Client Contact Method that the Phone Number created.
ContactPhonePkOriginal The primary key of the Client Contact Method that the Phone Number was loaded from.
ContactPhoneWork The Contact Work Phone Number for an Individual Applicant.
ContactPhoneWorkPk The primary key of the Client Contact Method that the Work Phone Number created.
ContactPhoneWorkPkOriginal The primary key of the Client Contact Method that the Work Phone Number was loaded from.
CreatedClientId The Id of the Client created from this Applicant.
CreatedClientPk The primary key of the Client Created from this Applicant.
CreatedDate Read-Only The 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.
DateOfBirth The Date of Birth for an Individual Applicant.
Dependants The Dependants for an Individual Applicant.
DriversLicenceDateOfBirth The Applicant's Date of Birth on their Drivers Licence.
DriversLicenceExpiryDate The Applicant's Drivers Licence Expiry Date.
DriversLicenceIssuer The Applicant's Driver's Licence Issuer.
DriversLicenceNameFamily The Family Name on the Applicant's Drivers Licence.
DriversLicenceNameOther The Other Names on the Applicant's Drivers Licence.
DriversLicenceNameResolved Read-Only The 'Other' and 'Family' Names on the Drivers Licence separated by a single space.
DriversLicenceNumber The Applicant's Drivers Licence Number.
DriversLicencePk The primary key of the Client Identification Item that the Drivers Licence was loaded from.
DriversLicenceSpecialType The Special Type for the Applicant's Drivers Licence
DriversLicenceSpecialTypeText Read-Only The Special Type Text for the Applicant's Drivers Licence
EmployerName The Name of the Applicant's current Employer.
EmployerPhone The Phone Number of the Applicant's current Employer.
EmployerPrevName The Name of the Applicant's previous Employer.
EmployerPrevPhone The Phone Number of the Applicant's previous Employer.
EmploymentDateStart The date the Applicant started at their current Employer.
EmploymentPk The primary key of the Client Employment Item that the current Employment details were loaded from.
EmploymentPrevDateStart The date the Applicant started at their previous Employer.
EmploymentPrevDateStop The date the Applicant stopped at their previous Employer.
EmploymentPrevPk The primary key of the Client Employment Item that the previous Employment details were loaded from.
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 An Id from an External Application to create a link between the databases.
FirstName The First Name for an Individual Applicant.
Gender The Gender for an Individual Applicant.
GenderText The Gender in its String representation.
GstExempt Indicates whether this Applicant is Exempt from paying GST.
GstNumber The GST Number for an Organisation Applicant.
ImageFileName The File Name of a Applicant Image.
ImageFileNameResolved Read-Only The Image File Name resolved into a fully qualified File Name.
Index Read-Only The Index of this item within its collection.
IndividualNumber The Individual Number.
IndustryCode The Industry Code.
IsDirty Read-Only Indicates whether this object has been modified since being created, loaded or refreshed.
IsFirstUsedApplicant Read-Only Indicates whether this is the first 'Used' Applicant in the collection, i.e., the one that is likely to become the Account's 'Main' Client.
IsIndividual Read-Only Indicates whether this is an 'Individual' Applicant (the default).
IsIndividualOrSoleTrader Read-Only Indicates whether this is an 'Individual' or 'Sole Trader' Applicant.
IsNew Read-Only Indicates whether this is a new record.
IsOrganisation Read-Only Indicates whether this is an 'Organisation' Applicant.
IsSoleTrader Read-Only Indicates whether this is a 'Sole Trader' Applicant.
JobTitle The Job Title for an Organisation Applicant's Person Acting.
Key The unique Key that identifies this item in the collection.
KeyLocked Indicates whether the Key should be locked in the User Interface to prevent Users from changing it.
LastName The Last Name for an Individual Applicant.
LegalName The Legal Name for an Organisation Applicant.
LegalNameResolved Read-Only The Legal Name for an Organisation Client or the Client Name if no Legal Name is specified.
LoadedFromClientId The Id of the Client from which this Applicant was loaded.
LoadedFromClientPk The primary key of the Client from which this Applicant was loaded.
MaritalStatus The Marital Status for an Individual Applicant.
MiddleNames The Middle Names for an Individual Applicant.
Name The Name of this Applicant.
NameFull Read-Only Gets the Full Name. For an Organisation the Company Name, unless personActing is True.
Notes Notes.
Occupation The Occupation for an Individual Applicant or a Sole Trader.
OrganisationNumber The Organisation Number for an Incorporated Organisation Applicant.
Parent Read-Only The parent collection.
PassportExpiryDate The Applicant's Passport Expiry Date.
PassportIssuer The Applicant's Passport Issuer.
PassportNumber The Applicant's Passport Number.
PassportPk The primary key of the Client Identification Item that the Passport was loaded from.
Pk This record's primary key.
PreferredName The Preferred Name for an Individual Applicant.
PreferredNameResolved Read-Only The Preferred Name for an Individual Applicant, or if Blank the Applicant's First Name.
PrivacyConsent Has consent been given by the Applicant to collect private information?
ResidencyStatus The Residency Status for an Individual Applicant.
Resident Indicates whether this Applicant is a Resident for Tax purposes.
ResidentialStatus The Residential Status for an Individual Applicant.
RoleJointResolved Read-Only System Use Only Obsolete
RoleType Read-Only System Use Only Obsolete
Salutation Salutation details.
SecurityParty When converted to an Account, should this Client be a party to the Security associated with this Account?
SendDocuments When converted to an Account, should this Client be sent Documents.
SendDocumentsResolved Read-Only Indicates whether this Applicant should receive Documents based on their Account Role and 'Used' status.
Tag The Tag property can be used to attach another value or object to this object.
TaxCategoryId The Id of this Applicant's Tax Category.
TaxCategoryPk The primary key of this Applicant's Tax Category.
TaxCountry The Country for GST Taxation.
TaxNumber The Tax Number for the Applicant.
TaxNumberSimple Read-Only The Tax Number, with any spaces or dashes removed.
Timestamp This record's Timestamp.
Title The Title for an Individual Applicant.
UpdateClient Indicates whether this Applicant should update the Client specified by ClientId when creating an Account.
UpdatedDate Read-Only The date and time this record was updated.
UpdatedUserPk The primary key of the User that updated this record.
UpdatedUtcDate The UTC date and time this record was updated.
Used Indicates whether this Applicant is Used and should therefore create or update a Client record when the Application is completed.
User Indexed User Defined data.
UserData Read-Only User Defined data.
UserDate User Defined "Date" Data.
UserDecimal User Defined "Decimal" Data.
UserInteger User Defined "Integer" Data.
Namespace:
Intersoft.finSupport6
Assembly:
finSupport6, Version=6.0.3
Target Framework:
.NET 9.0