Bookshelf v7.7: Contact

UCM Contact messages are used in insert, query, update, and delete operations to maintain Contact information. LookUpContact and LookUpContactByName are used for query operations. UpdateContact, InsertContact, and DeleteContact are message pairs for request and response operations. Figure 19 describes the structure of this message.

Table 67. Contact Integration Component Fields
Name	XML Tag	Data Type	Length	Req	Note
Contact
Alias	Alias	DTYPE_TEXT	50
Assistant	Assistant	DTYPE_TEXT	50
Assistant Phone #	AssistantPhone	DTYPE_TEXT	40
Best Call Time	BestCallTime	DTYPE_TEXT	30		Bound by FINCORP_CONTACT_CALL_TIME
Cellular Phone #	CellularPhone	DTYPE_TEXT	40
Customer Value	CustomerValue	DTYPE_TEXT	30		Bound by FIN_CON_VALUE_TYPE
Date of Birth	DateofBirth	DTYPE_DATE	7
Email Address	EmailAddress	DTYPE_TEXT	50
Email Address 2	EmailAddress2	DTYPE_TEXT	50
Fax Phone #	FaxPhone	DTYPE_TEXT	40
First Name	FirstName	DTYPE_TEXT	50	4
Home Phone #	HomePhone	DTYPE_TEXT	40
Id	Id	DTYPE_ID	15	4	This tag is required for Id cross-referencing. Tag stores incoming external Id.
Income	Income	DTYPE_CURRENCY	22
Income Currency Code	IncomeCurrencyCode	DTYPE_TEXT	20		Used for picking a related entity.
Income Exchange Date	IncomeExchangeDate	DTYPE_DATE	7
Integration Id	IntegrationId	DTYPE_TEXT	30
Job Title	JobTitle	DTYPE_TEXT	75
Last Name	LastName	DTYPE_TEXT	50	4
M/F	MF	DTYPE_TEXT	30		Bound by SEX_MF
M/M	MM	DTYPE_TEXT	15		Bound by MR_MS
Manager First Name	ManagerFirstName	DTYPE_TEXT	50
Manager Id	ManagerId	DTYPE_ID	15
Manager Integration Id	ManagerIntegrationId	DTYPE_TEXT	30
Manager Last Name	ManagerLastName	DTYPE_TEXT	50		Used for picking a related entity
Manager Middle Name	ManagerMiddleName	DTYPE_TEXT	50
Manager Primary Organization	ManagerPrimaryOrganization	DTYPE_TEXT	100
Manager Primary Organization Id	ManagerPrimaryOrganizationId	DTYPE_ID	15
Manager UId	ManagerUId	DTYPE_TEXT	100
Marital Status	MaritalStatus	DTYPE_TEXT	30		Bound by MARITAL_STATUS
Middle Name	MiddleName	DTYPE_TEXT	50
Mother Maiden Name	MotherMaidenName	DTYPE_TEXT	50
Party UId	PartyUId	DTYPE_TEXT	100
Person UId	PersonUId	DTYPE_TEXT	100
Preferred Communications	PreferredCommunications	DTYPE_TEXT	30		Bound by OFFER_MEDIA
Preferred Language Code	PreferredLanguageCode	DTYPE_TEXT	20
Privacy Code	PrivacyCode	DTYPE_TEXT	30		Bound by PRIVACY_CODE
Social Security Number	SocialSecurityNumber	DTYPE_TEXT	11
Status	Status	DTYPE_TEXT	30		Bound by CONTACT_STATUS
Suppress All Calls	SuppressAllCalls	DTYPE_TEXT	1
Suppress All Emails	SuppressAllEmails	DTYPE_TEXT	1
Suppress All Faxes	SuppressAllFaxes	DTYPE_TEXT	1
Suppress All Mailings	SuppressAllMailings	DTYPE_TEXT	1
Time Zone Id	TimeZoneId	DTYPE_ID	15
Time Zone Name	TimeZoneName	DTYPE_TEXT	100		Used for picking a related entity.
Work Phone #	WorkPhone	DTYPE_TEXT	40
Work Phone Extension	WorkPhoneExtension	DTYPE_TEXT	10
operation	operation	DTYPE_TEXT	30		System field
Account
Account	Account	DTYPE_TEXT	100	4
Account Location	AccountLocation	DTYPE_TEXT	50
Account Organization	AccountOrganization	DTYPE_TEXT	100
Account Party UId	AccountPartyUId	DTYPE_TEXT	100
Account Row Id	AccountRowId	DTYPE_ID	15
Account Status	AccountStatus	DTYPE_TEXT	24		Bound by ACCOUNT_STATUS
IsPrimaryMVG	IsPrimaryMVG	DTYPE_TEXT	1
Related Account Integration Id	RelatedAccountIntegrationId	DTYPE_TEXT	30
operation	operation	DTYPE_TEXT	30
Alternate Phone
Alternate Phone #	AlternatePhone	DTYPE_TEXT	40	4
Alternate Phone Id	AlternatePhoneId	DTYPE_ID	15
Alternate Phone Integration Id	AlternatePhoneIntegrationId	DTYPE_TEXT	30
Alternate Phone Medium Type	AlternatePhoneMediumType	DTYPE_TEXT	30
Alternate Phone Name	AlternatePhoneName	DTYPE_TEXT	50
IsPrimaryMVG	IsPrimaryMVG	DTYPE_TEXT	1
operation	operation	DTYPE_TEXT	30		System field
Communication Address
Alternate Email Address	AlternateEmailAddress	DTYPE_TEXT	100	4
Communication Address Id	CommunicationAddressId	DTYPE_ID	15
Communication Address Integration Id	CommunicationAddressIntegrationId	DTYPE_TEXT	30
Communication Address Medium Type	CommunicationAddressMediumType	DTYPE_TEXT	30
Communication Address Name	CommunicationAddressName	DTYPE_TEXT	50	4
IsPrimaryMVG	IsPrimaryMVG	DTYPE_TEXT	1
operation	operation	DTYPE_TEXT	30		System field
Household
Household Id	HouseholdId	DTYPE_ID	15
Household Integration Id	HouseholdIntegrationId	DTYPE_TEXT	30
Household Name	HouseholdName	DTYPE_TEXT	50
Household Number	HouseholdNumber	DTYPE_TEXT	100
Household Party UId	HouseholdPartyUId	DTYPE_TEXT	100
Household Status	HouseholdStatus	DTYPE_TEXT	30		Bound by HOUSEHOLD_STATUS
IsPrimaryMVG	IsPrimaryMVG	DTYPE_TEXT	1
operation	operation	DTYPE_TEXT	30
INS Personal Address
INS Personal Address Id	INSPersonalAddressId	DTYPE_ID	15
INS Personal Address Name	INSPersonalAddressName	DTYPE_TEXT	100
INS Personal Address Type	INSPersonalAddressType	DTYPE_TEXT	30
INS Personal City	INSPersonalCity	DTYPE_TEXT	50	4
INS Personal Country	INSPersonalCountry	DTYPE_TEXT	30		Bound by COUNTRY
INS Personal County	INSPersonalCounty	DTYPE_TEXT	50
INS Personal Integration Id	INSPersonalIntegrationId	DTYPE_TEXT	30
INS Personal Postal Code	INSPersonalPostalCode	DTYPE_TEXT	30
INS Personal State	INSPersonalState	DTYPE_TEXT	10		Bound by STATE_ABBREV
INS Personal Street Address	INSPersonalStreetAddress	DTYPE_TEXT	200	4
INS Personal Street Address 2	INSPersonalStreetAddress2	DTYPE_TEXT	100
IsPrimaryMVG	IsPrimaryMVG	DTYPE_TEXT	1
operation	operation	DTYPE_TEXT	30		System field
Organization
Division	Division	DTYPE_TEXT	255
IsPrimaryMVG	IsPrimaryMVG	DTYPE_TEXT	1
Position	Position	DTYPE_TEXT	50
Position Id	PositionId	DTYPE_ID	15
Position Integration Id	PositionIntegrationId	DTYPE_TEXT	30
Sales Rep	SalesRep	DTYPE_TEXT	50
operation	operation	DTYPE_TEXT	30		System field
Position
Division	Division	DTYPE_TEXT	255
IsPrimaryMVG	IsPrimaryMVG	DTYPE_TEXT	1
Position	Position	DTYPE_TEXT	50
Position Id	PositionId	DTYPE_ID	15
Position Integration Id	PositionIntegrationId	DTYPE_TEXT	30
Sales Rep	SalesRep	DTYPE_TEXT	50
operation	operation	DTYPE_TEXT	30		System field
Action
Account Id	AccountId	DTYPE_ID	15
Account Location	AccountLocation	DTYPE_TEXT	50
Account Name	AccountName	DTYPE_TEXT	100		Used for picking a related entity.
Audience	Audience	DTYPE_TEXT	30		Bound by ACTIVITY_AUDIENCE_TYPE
Category	Category	DTYPE_TEXT	30		Bound by TODO_TYPE
Description	Description	DTYPE_TEXT	100
Done	Done	DTYPE_UTCDATETIME	7
Done Flag	DoneFlag	DTYPE_TEXT	1
Due	Due	DTYPE_UTCDATETIME	7
Duration Minutes	DurationMinutes	DTYPE_INTEGER	22		Bound by APPOINTMENT_DURATION
Id	Id	DTYPE_ID	15
Integration Id	IntegrationId	DTYPE_TEXT	30
MeetingLocation	MeetingLocation	DTYPE_TEXT	100
No Sooner Than Date	NoSoonerThanDate	DTYPE_UTCDATETIME	7
Planned	Planned	DTYPE_UTCDATETIME	7
Started	Started	DTYPE_UTCDATETIME	7
Status	Status	DTYPE_TEXT	30		Bound by EVENT_STATUS
Type	Type	DTYPE_TEXT	30	4	Bound by TODO_TYPE
operation	operation	DTYPE_TEXT	30		System field
FINCORP Account
Account Branch ABA	AccountBranchABA	DTYPE_TEXT	50		Used for picking a related entity.
Account Branch Id	AccountBranchId	DTYPE_ID	15
Account Holder	AccountHolder	DTYPE_TEXT	100		Used for picking a related entity.
Account Name	AccountName	DTYPE_TEXT	100
Account Number	AccountNumber3	DTYPE_TEXT	100	4
Account Status	AccountStatus2	DTYPE_TEXT	30		Bound by FINS_CRPST_LFLN_IPFS_PLC_MLOV
Account Type	AccountType	DTYPE_TEXT	30		Bound by FINCORP_PROD_ADMIN_CLASS_MLOV
Acct Gen - Branch Id	AcctGen-BranchId	DTYPE_ID	15
Available Balance	AvailableBalance	DTYPE_CURRENCY	22
Billing Option	BillingOption	DTYPE_TEXT	30		Bound by FINCORP_ACCOUNT_BILL_OPTION
Branch	Branch	DTYPE_TEXT	50
Current Balance	CurrentBalance	DTYPE_CURRENCY	22
Id	Id	DTYPE_ID	15
Integration Id	IntegrationId	DTYPE_TEXT	30
Name	Name	DTYPE_TEXT	100	4	Used for picking a related entity
Organization Id	OrganizationId2	DTYPE_ID	15
Product Id	ProductId	DTYPE_ID	15	4
Relationship Limit	RelationshipLimit	DTYPE_CURRENCY	22
Start Date	StartDate	DTYPE_DATETIME	7
operation	operation	DTYPE_TEXT	30		System field