18ASIs and Messages for Oracle Master Data Management Applications

ASIs and Messages for Oracle Master Data Management Applications

This chapter describes the application services interfaces (ASIs) and messages for Oracle Master Data Management Applications. It contains the following topics:

• Application Services Interfaces for Oracle Master Data Management Applications

• Messages for Oracle Master Data Management Applications

Application Services Interfaces for Oracle Master Data Management Applications

Oracle Master Data Management Applications provide application services interfaces to interact and manage the customer information stored in the Customer Master.

Note: With the release of Siebel CRM version 8.1.1 Siebel Industry Applications, Customer Relationship Management Markup Language (CRMML) was deprecated in favor of the increased functionality of Web services. These Web services provide a more service-oriented interface to Oracle Customer Hub (UCM). It is recommended that you migrate from CRMML to these Web services as soon as is practical. CRMML will no longer be part of Siebel CRM releases as of version 8.1.1.6. If you are using CRMML in previous patch releases, such as Siebel CRM version 8.1.1.5 or earlier, then you may continue to use this functionality through August, 2012. CRMML will not be supported as of September 2012 and you will be directed to Web service-based solutions for future use. Further, CRMML is not supported for use with Siebel CRM version 8.2.x or with new features added to Oracle Customer Hub (UCM), version 8.2. For more information on Web services, see Oracle Customer Hub (UCM) and Data Governance Manager Web Services Reference.

The application service interfaces supported with Oracle Master Data Management Applications are:

• Manage Customer. Inbound message allowing querying, inserting, updating, and deleting of Contact, Account, and Household information, including relationships.

• Manage Address. Inbound message allowing querying, inserting, updating, and deleting of Addresses for Contacts, Accounts, and Households.

• Manage Profile. Inbound message allowing querying, inserting, updating, and deleting of Contact, Account, and Household profile information.

• Manage Activities. Inbound message allowing querying, inserting, updating, and deleting of Contact, Account, and Household activities.

• Manage Products. Inbound message allowing querying, inserting, updating, and deleting of products associated with Contacts, Accounts, and Households.

• Manage Cross-Reference. Request and response message allowing querying of Contact, Account, and Household cross-references.

• Lookup Customer by Product. Inbound message allowing the querying of Contacts, Accounts, and Households. The query is based on a product ID number.

• Lookup Relationships. Inbound message allowing querying Relationships between Contacts, Accounts, and Households.

• Lookup Batch Address. Inbound message allowing the querying of Contacts, Accounts, and Households. The query is based on address criteria.

• Publish Customer. Outbound message used for publishing.

  The following table lists each of the messages from Oracle Master Data Management Applications specifications.

  Integration Object Name	Business Processes or Operations
  UCMAccountExternalID	LookUpAccountExternalID
  UCMAccountExternalIDRs	LookUpAccountExternalIDResponse
  UCMContactExternalID	LookUpContactExternalID
  UCMContactExternalIDRs	LookUpContactExternalIDResponse
  UCMHouseholdExternalID	LookUpHouseholdExternalID
  UCMHouseholdExternalIDRs	LookUpHouseholdExternalIDResponse
  CIFAccount	LookUpAccount
  CIFAccountRs	LookUpAccountResponse
  CIFAccountActivity	LookUpAccountActivity
  CIFAccountActivityRs	LookUpAccountActivityResponse
  CIFAccountActivityByNameRs	LookUpAccountActivityByNameResponse
  CIFAccountActivityDelete	DeleteAccountActivity
  CIFAccountActivityDeleteRs	DeleteAccountActivityResponse
  CIFAccountActivityInsert	InsertAccountActivity
  CIFAccountActivityInsertRs	InsertAccountActivityResponse
  CIFAccountActivityUpdate	UpdateAccountActivity
  CIFAccountActivityUpdateRs	UpdateAccountActivityResponse
  CIFAccountAddress	LookUpAccountAddress
  CIFAccountAddressRs	LookUpAccountAddressResponse
  CIFAccountAddressDelete	DeleteAccountAddress
  CIFAccountAddressDeleteRs	DeleteAccountAddressResponse
  CIFAccountAddressInsert	InsertAccountAddress
  CIFAccountAddressInsertRs	InsertAccountAddressResponse
  CIFAccountAddressUpdate	UpdateAccountAddress
  CIFAccountAddressUpdateRs	UpdateAccountAddressResponse
  CIFAccountDelete	DeleteAccount
  CIFAccountDeleteRs	DeleteAccountResponse
  CIFAccountInsert	InsertAccount
  CIFAccountInsertRs	InsertAccountResponse
  CIFAccountProduct	LookUpAccountProduct
  CIFAccountProductRs	LookUpAccountProductResponse
  CIFAccountProductDelete	DeleteAccountProduct
  CIFAccountProductDeleteRs	DeleteAccountProductResponse
  CIFAccountProductInsert	InsertAccountProduct
  CIFAccountProductInsertRs	InsertAccountProductResponse
  CIFAccountProductUpdate	UpdateAccountProduct
  CIFAccountProductUpdateRs	UpdateAccountProductResponse
  CIFAccountProfile	LookUpAccountProfile
  CIFAccountProfileRs	LookUpAccountProfileResponse
  CIFAccountProfileByName	LookUpAccountProfileByName
  CIFAccountProfileByNameRs	LookUpAccountProfileByNameResponse
  CIFAccountProfileDelete	DeleteAccountProfile
  CIFAccountProfileDeleteRs	DeleteAccountProfileResponse
  CIFAccountProfileInsert	InsertAccountProfile
  CIFAccountProfileInsertRs	InsertAccountProfileResponse
  CIFAccountProfileUpdate	UpdateAccountProfile
  CIFAccountProfileUpdateRs	UpdateAccountProfileResponse
  CIFAccountRelationship	LookUpAccountRelationship
  CIFAccountRelationshipRs	LookUpAccountRelationshipResponse
  CIFAccountRelationshipDelete	DeleteAccountRelationship
  CIFAccountRelationshipDeleteRs	DeleteAccountRelationshipResponse
  CIFAccountRelationshipInsert	InsertAccountRelationship
  CIFAccountRelationshipInsertRs	InsertAccountRelationshipResponse
  CIFAccountRelationshipUpdate	UpdateAccountRelationship
  CIFAccountRelationshipUpdateRs	UpdateAccountRelationshipResponse
  CIFAccountUpdate	UpdateAccount
  CIFAccountUpdateRs	UpdateAccountResponse
  CIFContact	LookUpContact
  CIFContactRs	LookUpContactResponse
  CIFContactActivity	LookUpContactActivity
  CIFContactActivityRs	LookUpContactActivityResponse
  CIFContactActivityByName	LookUpContactActivityByName
  CIFContactActivityByNameRs	LookUpContactActivityByNameResponse
  CIFContactActivityDelete	DeleteContactActivity
  CIFContactActivityDeleteRs	DeleteContactActivityResponse
  CIFContactActivityInsert	InsertContactActivity
  CIFContactActivityInsertRs	InsertContactActivityResponse
  CIFContactActivityUpdate	UpdateContactActivity
  CIFContactActivityUpdateRs	UpdateContactActivityResponse
  CIFContactAddress	LookUpContactAddress
  CIFContactAddressRs	LookUpContactAddressResponse
  CIFContactAddressByName	LookUpContactAddressByName
  CIFContactAddressByNameRs	LookUpContactAddressByNameResponse
  CIFContactAddressDelete	DeleteContactAddress
  CIFContactAddressDeleteRs	DeleteContactAddressResponse
  CIFContactAddressInsert	InsertContactAddress
  CIFContactAddressInsertRs	InsertContactAddressResponse
  CIFContactAddressUpdate	UpdateContactAddress
  CIFContactAddressUpdateRs	UpdateContactAddressResponse
  CIFContactByName	LookUpContactByName
  CIFContactByNameRs	LookUpContactByNameResponse
  CIFContactDelete	DeleteContact
  CIFContactDeleteRs	DeleteContactResponse
  CIFContactExternalId	LookUpContactExternalId
  CIFContactExternalIdRs	LookUpContactExternalIdResponse
  CIFContactInsert	InsertContact
  CIFContactInsertRs	InsertContactResponse
  CIFContactProduct	LookUpContactProduct
  CIFContactProductRs	LookUpContactProductResponse
  CIFContactProductByName	LookUpContactProductByName
  CIFContactProductByNameRs	LookUpContactProductByNameResponse
  CIFContactProductDelete	DeleteContactProduct
  CIFContactProductDeleteRs	DeleteContactProductResponse
  CIFContactProductInsert	InsertContactProduct
  CIFContactProductInsertRs	InsertContactProductResponse
  CIFContactProductUpdate	UpdateContactProduct
  CIFContactProductUpdateRs	UpdateContactProductResponse
  CIFContactProfile	LookUpContactProfile
  CIFContactProfileRs	LookUpContactProfileResponse
  CIFContactProfileByName	LookUpContactProfileByName
  CIFContactProfileByNameRs	LookUpContactProfileByNameResponse
  CIFContactProfileDelete	DeleteContactProfile
  CIFContactProfileDeleteRs	DeleteContactProfileResponse
  CIFContactProfileInsert	InsertContactProfile
  CIFContactProfileInsertRs	InsertContactProfileResponse
  CIFContactProfileUpdate	UpdateContactProfile
  CIFContactProfileUpdateRs	UpdateContactProfileResponse
  CIFContactRelationship	LookUpContactRelationship
  CIFContactRelationshipRs	LookUpContactRelationshipResponse
  CIFContactRelationshipByName	LookUpContactRelationshipByName
  CIFContactRelationshipByNameRs	LookUpContactRelationshipByNameResponse
  CIFContactRelationshipDelete	DeleteContactRelationship
  CIFContactRelationshipDeleteRs	DeleteContactRelationshipResponse
  CIFContactRelationshipInsert	InsertContactRelationship
  CIFContactRelationshipInsertRs	InsertContactRelationshipResponse
  CIFContactRelationshipUpdate	UpdateContactRelationship
  CIFContactRelationshipUpdateRs	UpdateContactRelationshipResponse
  CIFContactUpdate	UpdateContact
  CIFContactUpdateRs	UpdateContactResponse
  CIFFINCORPAccount	LookUpFINCORPAccount
  CIFFINCORPAccountRs	LookUpFINCORPAccountResponse
  CIFFINCORPAccountByName	LookUpFINCORPAccountByName
  CIFFINCORPAccountByNameRs	LookUpFINCORPAccountByNameResponse
  CIFHousehold	LookUpHousehold
  CIFHouseholdRs	LookUpHouseholdResponse
  CIFHouseholdByName	LookUpHouseholdByName
  CIFHouseholdByNameRs	LookUpHouseholdByNameResponse
  CIFHouseholdDelete	DeleteHousehold
  CIFHouseholdDeleteRs	DeleteHouseholdResponse
  CIFHouseholdInsert	InsertHousehold
  CIFHouseholdInsertRs	InsertHouseholdResponse
  CIFHouseholdUpdate	UpdateHousehold
  CIFHouseholdUpdateRs	UpdateHouseholdResponse
  CIFPersonalAddress	LookUpPersonalAddress
  CIFPersonalAddressRs	LookUpPersonalAddressResponse
  CIFPersonalAddressByState	LookUpPersonalAddressByState
  CIFPersonalAddressByStateRs	LookUpPersonalAddressByStateResponse

About CRMML Messages

Customer Relationship Management Markup Language (CRMML) is a Siebel XML specification for customer-centric data exchange with other enterprise applications and Oracle Customer Hub (UCM) applications. External applications send CRMML request messages to Siebel Business Applications and receive CRMML messages in response.

CRMML messages contain an envelope, a header section, and a body section. The message specification focuses on the hierarchy and definitions of the header elements. It allows users to extend the body section with user-defined elements as long as the object descriptors in the header section describe the usage of the elements in a body section.

Code Example of a CRMML Message

The following example illustrates the layers of a CRMML message:

<?xml version="1.0" encoding="UTF-8>
<CRMML>
<! CRMML Header section starts>
      <CRMHeader>
            <FromSystem>
                  <SystemInfo type="ID">
                  <SystemId>www.mycompany.com</SystemId>
                  <SystemRole>Insurance Application</SystemRole>
                  <SystemName>Client UI System</SystemName>
                  </SystemInfo>
            </FromSystem>
            <ToSystem>
                  <SystemInfo type="ID">
                  <SystemId>123-456-789</SystemId>
                  <SystemRole>Service Provider</SystemRole>
                  <SystemName>Siebel UCM System</SystemName>
                   </SystemInfo>
            </ToSystem>
            <MessageDescriptor>
                  <MessageId>11SC3I2002053116:43:45</MessageId>
                  <TransactionScope>any</TransactionScope>
                  <Timestamp>01/01/2001</Timestamp>
                  <TimeToLive>365</TimeToLive>
            </MessageDescriptor>
      </CRMHeader>
<!CRMML Header section ends>
     <PartyPackage>
     <InsertContactProfile>
        <Contact>
            <Id>ext2223</Id>
            <EmailAddress>cifemail</EmailAddress>
            <FaxPhone>5555555555</FaxPhone>
            <FirstName>0099INFN</FirstName>
            <HomePhone>1111111111</HomePhone>
            <LastName>0099INLN</LastName>
            </InsertContactProfile>
            </PartyPackage>
</CRMML>

Envelope and Header Section

The CRMML message has one envelope element <CRMML>. <CRMML> is the root element for a message. It contains one optional header element <CRMHeader> and one or more body elements. The envelope has no attributes.

The header includes elements for sender and receiver. The following is an example for communication parties:

<! CRMML Header section starts>
<CRMHeader>
   <FromSystem>
   <SystemInfo type="ID">
     <SystemId>www.mycompany.com</SystemId>
     <SystemRole>Insurance Application</SystemRole>
     <SystemName>Client UI System</SystemName>
   </SystemInfo>
 </FromSystem>
<ToSystem>
   <SystemInfo type="ID">
    <SystemId>123-456-789</SystemId>
      <SystemRole>Service Provider</SystemRole>
        <SystemName>Siebel UCM System</SystemName>
         </SystemInfo>
          </ToSystem>
         …
<CRMHeader>

In this code example, note the elements.

where:

• <FromSystem> is the sender.

• <ToSystem> is the receiver.

• <SystemInfo> holds the system ID, system role, and the name of the system.

Both elements contain <SystemInfo> aggregate. In the example, sender is Client UI System and receiver is Siebel Master Data Applications System. Sender plays an insurance application role, and receiver plays a service provider's role.

The header also contains a message descriptor that depicts the body of the message and objects inside the body sections. An example of the message descriptor follows:

<CRMML>
<! CRMML Header section starts>
    <CRMHeader>
      <MessageDescriptor>
        <MessageId>11SC3I2002053116:43:45</MessageId>
        <TransactionScope>any</TransactionScope>
        <Timestamp>Sunday</Timestamp>
        <TimeToLive>OneYear</TimeToLive>
      </MessageDescriptor>
</CRMHeader>

where:

• <MessageId> identifies a single message, a pair of request or response messages, or a group of communication messages.

• <Transaction scope> can be set to Any or All.

• <Timestamp> is the creation time of a message

• <TimeToLive> is the expiration time of a message. The receiver disregards a message if the message has expired.

• <MessageDescriptor> can have zero or more <ObjectDescriptor> child elements.

The following object descriptor example illustrates the metadata for a remote procedure call in a message header:

<CRMHeader>
    <MessageDescriptor>
     …<ObjectDescriptor>
     <ObjectId type="HREF" sytem="this">p1</ObjectId>
           <ObjectUsage>SoftwarePackage</ObjectUsage>
            </ObjectDescriptor>
            <ObjectDescriptor>
              <ObjectId type="HREF" sytem="this">m1</ObjectId>
             <ObjectUsage>Method</ObjectUsage>
             </ObjectDescriptor>
      <ObjectDescriptor>
          <ObjectId type="HREF" sytem="this">a1</ObjectId>
          <ObjectUsage>Argument</ObjectUsage>
        </ObjectDescriptor>
        </MessageDescriptor>
</CRMHeader>
<PartyPackage ID="p1">
   <InsertContactProfile ID="m1">
      <Contact ID="a1">
         <Id>ext2223</Id>

where:

• First <ObjectDescriptor>. Refers to the <PartyPackage> element in the message body by HREF. It indicates that <PartyPackage> is a software package. In this example, it is the Oracle Customer Hub (UCM).

• Second <ObjectDescriptor>. Indicates that <InsertContactProfile> is a method in the package that the message intends to invoke.

• Third <ObjectDescriptor>. Shows that <Contact> aggregate is the input argument for <InsertContactProfile>.

For an implementation of Oracle Customer Hub (UCM), the default usages of the first three elements are package, method, and argument. Therefore, no objective descriptor is required for Oracle Customer Hub (UCM) specific messages.

Certain values in the header are automatically generated by the connector, but you can specify others in the envelope integration object. The following table describes the elements and how they are configured. For system-generated attributes, there is no configuration available.

Note: The CRMML envelope object information can be configured. It contains custom fields and works for both input and output formats. However, business services for Oracle Customer Hub (UCM) refer to information in this object and look for specific XML values. Make sure the specific fields exist in the business services before configuring CRMML.

Element	Structure	Attribute	Description	Default	Configuration
CRMML	(top level)
CRMHeader	In CRMML	Not applicable	Header aggregate	Not applicable	Not applicable
FromSystem	In CRMHeader	Not applicable	FromSystem aggregate	Not applicable	Not applicable
SystemInfo	In FromSystem	Not applicable	SystemInfo aggregate	Not applicable	Not applicable
		Type	Describes the type of SystemID such as ID or URL	ID	UCM Envelope Integration Object- SystemInfo Integration Component-type Integration Component Field, XML Literal Value
		SystemId	Identifier of the system	123-456-789	UCM Envelope Integration Object- SystemInfo Integration Component- SystemId Integration Component Field, XML Literal Value
		SystemName	Name of the system	SiebelCIFSystem	UCM Envelope Integration Object- SystemInfo Integration Component- SystemName Integration Component Field, XML Literal Value
		SystemRole	The role that the system has.	Service Provider	UCM Envelope Integration Object- SystemInfo Integration Component- SystemRole Integration Component Field, XML Literal Value
ToSystem	In CRMHeader	Not applicable	ToSystem aggregate	Not applicable	Not applicable
SystemInfo	In ToSystem	Not applicable	SystemInfo aggregate	Not applicable	Not applicable
		Type	Describes the type of SystemID such as ID or URL.	ID	UCM Envelope Integration Object- SystemInfo Integration Component- ToSystem_type Integration Component Field, XML Literal Value
		SystemId	Identifier of the system	Not applicable	System generated
		SystemName	Name of the system	Not applicable	System generated
		SystemRole	The role that the system has.	Not applicable	System generated
Message Descriptor	In CRMHeader	MessageId	Identifier of the message	Not applicable	System generated
		Transaction Scope	Currently, the only value supported for transaction scope is: Any.	Not applicable	UCM Envelope Integration Object->MessageDescriptor Integration Component->MessageDescriptor_TrasactionScope Integration Component Field, XML Literal Value
		Timestamp	Time stamp of when the message is constructed	Not applicable	System generated
		TimeToLive	Expiration length of the message from Timestamp value	Not applicable	UCM Envelope Integration Object->MessageDescriptor Integration Component->MessageDescriptor_ToLive Integration Component Field, XML Literal Value

Body Section

The body section contains user-defined message elements. The following is an example body section and is one of the messages supported by Siebel Master Data Management Applications.

<CRMML>
    <CRMHeader>
   …
   </CRMHeader>
   <PartyPackage ID="p1">
      <InsertContactProfile ID="m1">
        <Contact ID="a1">
          <Id>ext2223</Id>
             …

The example indicates that an external application requests to insert a contact profile to the Siebel Master Data Applications database. The contact detail information is contained within the <Contact> aggregate.

Messages for Oracle Master Data Management Applications

Oracle Master Data Management Applications messages provide a solution for enterprise customer, partner, and prospect data management and access. Oracle Master Data Management Applications messages, embedded in CRMML XML messages, interact with systems in the enterprise application network and function as the system of record for customer data.

Contact Profile

Contact profile messages are used in insert, query, update, and delete operations to maintain Contact Profile Information. The LookUpContactProfile and LookUpContactProfileByName XML tags are used for query operations. UpdateContactProfile, InsertContactProfile, and DeleteContactProfile are message pairs for request and response operations. The following figure describes the structure of this message.

The following table lists the Contact Profile Query Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactProfile	Contact	LookUpContactProfile	User key 1 (UK1) is PartyUId. User key 2 (UK2) is Id.
CIFContactProfileRs	Contact	LookUpContactProfileResponse	User key 1 (UK1) is PartyUId. User key 2 (UK2) is Id.

The following table lists the Contact Profile Query by Name Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactProfileByName	Contact	LookUpContactProfileByName	User key 1 (UK1) is PartyUId. User key 2 (UK2) is Id.
CIFContactProfileByNameRs	Contact	LookUpContactProfileByNameResponse	User key 1 (UK1) is PartyUId. User key 2 (UK2) is Id.

The following table lists the Contact Profile Update Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactProfileUpdate	Contact	UpdateContactProfile	User key 1 (UK1) is PartyUId. User key 2 (UK2) is Id.
CIFContactProfileUpdateRs	Contact	UpdateContactProfileResponse	User key 1 (UK1) is PartyUId. User key 2 (UK2) is Id.

The following table lists the Contact Profile Insert Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactProfileInsert	Contact	InsertContactProfile	User key 1 (UK1) is PartyUId. User key 2 (UK2) is Id.
CIFContactProfileUpdateRs	Contact	InsertContactProfileResponse	User key 1 (UK1) is PartyUId. User key 2 (UK2) is Id.

The following table lists the Contact Profile Delete integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactProfileDelete	Contact	DeleteContactProfile	User key 1 (UK1) is PartyUId. User key 2 (UK2) is Id.
CIFContactProfileDeleteRs	Contact	DeleteContactProfileResponse	User key 1 (UK1) is PartyUId. User key 2 (UK2) is Id.

The following table lists the Contact Profile Integration component and Integration Component Fields.

Name	XML Tag	Data Type	Length	Req	Comments
Alias	Alias	Text	50	No	None
Assistant	Assistant	Text	50	No	None
Assistant Phone #	AssistantPhone	Text	40	No	None
Best Call Time	BestCallTime	Text	30	No	Bound by FINCORP_CONTACT_CALL_TIME
Cellular Phone #	CellularPhone	Text	40	No	None
Customer Value	CustomerValue	Text	30	No	Bound by FIN_CON_VALUE_TYPE
Date of Birth	DateofBirth	Date	7	No	None
Email Address	EmailAddress	Text	50	No	None
Email Address 2	EmailAddress2	Text	50	No	None
Fax Phone #	FaxPhone	Text	40	No	None
First Name	FirstName	Text	50	Yes	None
Home Phone #	HomePhone	Text	40	Yes	None
Id	Id	Id	15	Yes	This tag is required for ID cross-referencing. The tag stores the incoming external ID.
Integration Id	IntegrationId	Text	30	No	None
Job Title	JobTitle	Text	75	No	None
Last Name	LastName	Text	50	Yes	None
M/F	MF	Text	30	No	Bound by SEX_MF
M/M	MM	Text	15	No	Bound by MR_MS
Marital Status	MaritalStatus	Text	30	No	Bound by MARITAL_STATUS
Middle Name	MiddleName	Text	50	No
Mother Maiden Name	MotherMaidenName	Text	50	No	None
Party UId	PartyUId	Text	100	No	None
Person UId	PersonUId	Text	100	No	None
Personal Contact	PersonalContact	Text	1	No	None
Preferred Communications	PreferredCommunications	Text	30	No	Bound by OFFER_MEDIA
Privacy Code	PrivacyCode	Text	30	No	Bound by PRIVACY_CODE
Social Security Number	SocialSecurityNumber	Text	20	No	None
Status	Status	Text	30	No	Bound by CONTACT_STATUS
Suppress All Calls	SuppressAllCalls	Text	1	No	None
Suppress All Emails	SuppressAllEmails	Text	1	No	None
Suppress All Faxes	SuppressAllFaxes	Text	1	No	None
Suppress All Mailings	SuppressAllMailings	Text	1	No	None
Suppress Share	SuppressShare	Text	1	No	None
Time Zone Id	TimeZoneId	Id	15	No	None
Time Zone Name	TimeZoneName	Text	100	No	Used for choosing g a related entity
Work Phone #	WorkPhone	Text	40	No	None
Work Phone Extension	WorkPhoneExtension	Text	10	No	None
operation	operation	Text	30	No	System field

Contact Address

Contact address messages are used in insert, query, update, and delete operations to maintain Contact Address Information. The LookUpContactAddress and LookUpContactAddressByName XML tags are used for query operations. UpdateContactAddress, InsertContactAddresse, and DeleteContactAddress are message pairs for request and response operations. The following figure describes the structure of this message.

The following table lists the Contact Address Query Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactAddress	Contact	LookUpContactAddress	UK1:PartyUId UK2: Id
CIFContactAddressRs	Contact	LookUpContactAddressResponse	UK1:PartyUId UK2: Id

The following table lists the Contact Address Query by Name Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactAddressByName	Contact	LookUpContactAddressByName	UK1:PartyUId UK2: Id
CIFContactAddressByNameRs	Contact	LookUpContactAddressByNameResponse	UK1:PartyUId UK2: Id

The following table lists the Contact Address Update Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactAddressUpdate	Contact	UpdateContactAddress	UK1:PartyUId UK2: Id
CIFContactAddressUpdateRs	Contact	UpdateContactAddressResponse	UK1:PartyUId UK2: Id

The following table lists the Contact Address Insert Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactAddressInsert	Contact	InsertContactAddress	UK1:PartyUId UK2: Id
CIFContactAddressInsertRs	Contact	InsertContactAddressResponse	UK1:PartyUId UK2: Id

The following table lists the Contact Address Delete Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactAddressDelete	Contact	DeleteContactAddress	UK1:PartyUId UK2: Id
CIFContactAddressDeleteRs	Contact	DeleteContactAddressResponse	UK1:PartyUId UK2: Id

The following table lists the Contact Address Integration Component and Integration Component Fields.

Name	XML Tag	Data Type	Length	Req	Comments
IC: Contact
Fax Phone #	FaxPhone	Text	40	No	None
First Name	FirstName	Text	50	Yes	None
Id	Id	Id	15	Yes	This tag is required for ID cross-referencing. It stores the incoming external ID.
Integration Id	IntegrationId	Text	30	No	None
Job Title	JobTitle	Text	75	No	None
Last Name	LastName	Text	50	Yes	None
M/M	MM	Text	15	No	Bound by MR_MS
Middle Name	MiddleName	Text	50	No	None
Party UId	PartyUId	Text	100	No	None
Person UId	PersonUId	Text	100	No	None
Privacy Code	PrivacyCode	Text	30	No	None
Status	Status	Text	30	No	Determined by CONTACT_STATUS
Work Phone #	WorkPhone	Text	40	No	None
Work Phone Extension	WorkPhoneExtension	Text	10	No	None
operation	operation	Text	30	No	None
IC: Contact_INS Personal Address
INS Personal Address Id	INSPersonalAddressId	Id	15	No	None
INS Personal Address Name	INSPersonalAddressName	Text	100	No	None
INS Personal Address Type	INSPersonalAddressType	Text	30	No	None
INS Personal City	INSPersonalCity	Text	50	Yes	None
INS Personal Country	INSPersonalCountry	Text	30	No	None
INS Personal County	INSPersonalCounty	Text	50	No	None
INS Personal Integration Id	INSPersonalIntegrationId	Text	30	No	None
INS Personal Postal Code	INSPersonalPostalCode	Text	30	No	None
INS Personal State	INSPersonalState	Text	10	No	None
INS Personal Street Address	INSPersonalStreetAddress	Text	200	Yes	None
INS Personal Street Address 2	INSPersonalStreetAddress2	Text	100	No	None
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
operation	operation	Text	30	No	None

Contact Activity

Contact activity messages are used in insert, query, update, and delete operations to maintain Contact Activity Information. The LookUpContactActivity and LookUpContactActivityByName XML tags are used for query operations. UpdateContactActivity, InsertContactActivity, and DeleteContactActivity are message pairs for request and response operations. The following figure describes the structure of this message.

The following table lists the Contact Activity Query Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactActivity	Contact	LookUpContactActivity	UK1:PartyUId UK2: Id
CIFContactActivityRs	Contact	LookUpContactActivityResponse	UK1:PartyUId UK2: Id

The following table lists the Contact Activity Query by Name Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactActivityByName	Contact	LookUpContactActivityByName	UK1:PartyUId UK2: Id
CIFContactActivityByNameRs	Contact	LookUpContactActivityByNameResponse	UK1:PartyUId UK2: Id

The following table lists the Contact Activity Update Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactActivityUpdate	Contact	UpdateContactActivity	UK1:PartyUId UK2: Id
CIFContactActivityUpdateRs	Contact	UpdateContactActivityResponse	UK1:PartyUId UK2: Id

The following table lists the Contact Activity Insert Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactActivityInsert	Contact	InsertContactActivity	UK1:PartyUId UK2: Id
CIFContactActivityInsertRs	Contact	InsertContactActivityResponse	UK1:PartyUId UK2: Id

The following table lists the Contact Activity Delete Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactActivityDelete	Contact	DeleteContactActivity	UK1:PartyUId UK2: Id
CIFContactActivityDeleteRs	Contact	DeleteContactActivityResponse	UK1:PartyUId UK2: Id

The following table lists the Contact Activity Integration Component and Integration Component Fields.

Name	XML Tag	Data Type	Length	Req	Comments
IC: Contact
Assistant	Assistant	Text	50	No	None
Assistant Phone #	AssistantPhone	Text	40	No	None
Cellular Phone #	CellularPhone	Text	40	No	None
Email Address	EmailAddress	Text	50	No	None
Fax Phone #	FaxPhone	Text	40	No	None
First Name	FirstName	Text	50	Yes	None
Home Phone #	HomePhone	Text	40	No	None
Id	Id	Id	15	Yes	This tag is required for ID cross-referencing. It stores the incoming external ID.
Integration Id	IntegrationId	Text	30	No	None
Job Title	JobTitle	Text	75	No	None
Last Name	LastName	Text	50	Yes	None
M/F	MF	Text	30	No	Bound by SEX_MF
M/M	MM	Text	15	No	Bound by MR_MS
Middle Name	MiddleName	Text	50	No	None
Party UId	PartyUId	Text	100	No	None
Person UId	PersonUId	Text	100	No	None
Preferred Communications	PreferredCommunications	Text	30	No	Bound by OFFER_MEDIA
Status	Status	Text	30	No	Bound by CONTACT_STATUS
Work Phone #	WorkPhone	Text	40	No	None
Work Phone Extension	WorkPhoneExtension	Text	10	No	None
operation	operation	Text	30	No	None
IC: Action
Account Id	AccountId	Id	15	No	None
Account Location	AccountLocation	Text	50	No	None
Account Name	AccountName	Text	100	No	Used for picking a related entity.
Audience	Audience	Text	30	No	Bound by ACTIVITY_AUDIENCE_TYPE
Category	Category	Text	30	No	Bound by TODO_TYPE
Description	Description	Text	100	No	None
Done	Done	Date and time	7	No	None
Done Flag	DoneFlag	Text	1	No	None
Due	Due	Date and time	7	No	None
Duration Minutes	DurationMinutes	Number	22	No	Bound by APPOINTMENT_DURATION
Id	Id	Id	15	No	None
Integration Id	IntegrationId	Text	30	No	None
MeetingLocation	MeetingLocation	Text	100	No	None
No Sooner Than Date	NoSoonerThanDate	UTC date time	7	No	None
Planned	Planned	UTC date time	7	No	None
Planned Completion	PlannedCompletion	UTC date time	7	No	None
Priority	Priority	Text	30	No	None
Started	Started	UTC date time	7	No	None
Status	Status	Text	30	No	Bound by EVENT_STATUS
Type	Type	Text	30	Yes	Bound by TODO_TYPE
operation	operation	Text	30	No	None

Contact Product

Contact Products messages are used in insert, query, update, and delete operations to maintain Contact Product (Financial Account) Information. The LookUpContactProduct and LookUpContactProductByName XML tags are used for query operations. UpdateContactProduct, InsertContactProduct, and DeleteContactProduct are message pairs for request and response operations. The following figure describes the structure of this message

The following table lists the Contact Product Query Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactProduct	Contact	LookUpContactProduct	UK1:PartyUId UK2: Id
CIFContactProductRs	Contact	LookUpContactProductResponse	UK1:PartyUId UK2: Id

The following table lists the Contact Product Query by Name Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactProductByName	Contact	LookUpContactProductByName	UK1:PartyUId UK2: Id
CIFContactProductByNameR	Contact	LookUpContactProductByNameResponse	UK1:PartyUId UK2: Id

The following table lists the Contact Product Update Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactProductUpdate	Contact	UpdateContactProduct	UK1:PartyUId UK2: Id
CIFContactProductUpdateRs	Contact	UpdateContactProductResponse	UK1:PartyUId UK2: Id

The following table lists the Contact Product Insert Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactProductInsert	Contact	InsertContactProduct	UK1:PartyUId UK2: Id
CIFContactProductInsertRs	Contact	InsertContactProductResponse	UK1:PartyUId UK2: Id

The following table lists the Contact Product Delete Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactProductDelete	Contact	DeleteContactProduct	UK1:PartyUId UK2: Id
CIFContactProductDeleteRs	Contact	DeleteContactProductResponse	UK1:PartyUId UK2: Id

The following table lists the Contact Product Integration Component and Integration Component Fields.

Name	XML Tag	Data Type	Length	Req	Comments
IC: Contact
Assistant	Assistant	Text	50	No	None
Assistant Phone #	AssistantPhone	Text	40	No	None
Cellular Phone #	CellularPhone	Text	40	No	None
Email Address	EmailAddress	Text	50	No	None
Fax Phone #	FaxPhone	Text	40	No	None
First Name	FirstName	Text	50	Yes	None
Home Phone #	HomePhone	Text	40	No	None
Id	Id	Id	15	Yes	This tag is required for ID cross-referencing. It stores the incoming external ID.
Integration Id	IntegrationId	Text	30	No	None
Job Title	JobTitle	Text	75	No	None
Last Name	LastName	Text	50	Yes	None
M/F	MF	Text	255	No	Bound by SEX_MF
M/M	MM	Text	15	No	Bound by MR_MS
Middle Name	MiddleName	Text	50	No	None
Party UId	PartyUId	Text	100	No	None
Person UId	PersonUId	Text	100	No	None
Preferred Communications	PreferredCommunications	Text	30	No	Bound by OFFER_MEDIA
Status	Status	Text	30	No	None
Work Phone #	WorkPhone	Text	40	No	None
Work Phone Extension	WorkPhoneExtension	Text	10	No	None
operation	operation	Text	30	No	None
IC: FINCORP Account
Account Branch ABA	AccountBranchABA	Text	50	No	Used for picking a related entity.
Account Branch Id	AccountBranchId	Id	15	No	None
Account Holder	AccountHolder	Text	100	No	Used for picking a related entity.
Account Name	AccountName	Text	100	No	None
Account Number	AccountNumber	Text	100	Yes	None
Account Status	AccountStatus	Text	30	No	Bound by FINS_CRPST_LFLN_IPFS_PLC_MLOV
Account Type	AccountType	Text	30	No	Bound by FINCORP_PROD_ADMIN_CLASS_MLOV
Acct Gen - Branch Id	AcctGen-BranchId	Id	15	No	None
Available Balance	AvailableBalance	Currency	22	No	None
Branch	Branch	Text	50	No	None
Current Balance	CurrentBalance	Currency	22	No	None
Id	Id	Id	15	No	None
Integration Id	IntegrationId	Text	30	No	None
Name	Name	Text	100	Yes	Used for picking a related entity
Organization Id	OrganizationId	Id	15	Yes	None
Product Id	ProductId	Id	15	Yes	None
Relationship Limit	RelationshipLimit	Currency	22	No	None
Start Date	StartDate	Date	7	No	None
operation	operation	Text	30	No	None

Contact Relationship

Contact Relationship messages are used in insert, query, update, and delete operations to maintain Contact Relationships. The LookUpContactRelationship and LookUpContactRelationshipByName XML tags are used for query operations. The UpdateContactRelationship, InsertContactRelationship and DeleteContactRelationship XML tags are message pairs for request and response operations. The following figure describes the structure of this message.

The following table lists the Contact Relationship Query Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactRelationship	Contact	LookUpContactRelationship	UK1:PartyUId UK2: Id
CIFContactRelationshipRs	Contact	LookUpContactRelationshipResponse	UK1:PartyUId UK2: Id

The following table lists the Contact Relationship Query by Name Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactRelationshipByName	Contact	LookUpContactRelationshipByName	UK1:PartyUId UK2: Id
CIFContactRelationshipByNameRs	Contact	LookUpContactRelationshipByNameResponse	UK1:PartyUId UK2: Id

The following table lists the Contact Relationship Update Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactRelationshipUpdate	Contact	UpdateContactRelationship	UK1:PartyUId UK2: Id
CIFContactRelationshipUpdateRs	Contact	UpdateContactRelationshipResponse	UK1:PartyUId UK2: Id

The following table lists the Contact Relationship Insert Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactRelationshipInsert	Contact	InsertContactRelationship	UK1:PartyUId UK2: Id
CIFContactRelationshipInsertRs	Contact	InsertContactRelationshipResponse	UK1:PartyUId UK2: Id

The following table lists the Contact Relationship Delete Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactRelationshipDelete	Contact	DeleteContactRelationship	UK1:PartyUId UK2: Id
CIFContactRelationshipDeleteRs	Contact	DeleteContactRelationshipResponse	UK1:PartyUId UK2: Id

The following table lists the Contact Relationship Integration Component and Integration Component Fields.

Name	XML Tag	Data Type	Length	Req	Comments
IC: Contact
Assistant	Assistant	Text	50	No	None
Assistant Phone #	AssistantPhone	Text	40	No	None
Cellular Phone #	CellularPhone	Text	40	No	None
Email Address	EmailAddress	Text	50	No	None
Fax Phone #	FaxPhone	Text	40	No	None
First Name	FirstName	Text	50	Yes	None
Home Phone #	HomePhone	Text	40	No	None
Id	Id	Id	15	Yes	This tag is required for ID cross-referencing. It stores the incoming external ID.
Integration Id	IntegrationId	Text	30	No	None
Job Title	JobTitle	Text	75	No	None
Last Name	LastName	Text	50	Yes	None
M/F	MF	Text	30	No	Bound by SEX_MF
M/M	MM	Text	15	No	Bound by MR_MS
Manager First Name	ManagerFirstName	Text	50	No	None
Manager Id	ManagerId	Id		No	None
Manager Integration Id	ManagerIntegrationId	Text	30	No	None
Manager Last Name	ManagerLastName	Text	50	No	Used for picking a related entity.
Manager Middle Name	ManagerMiddleName	Text	50	No	None
Manager Primary Organization	ManagerPrimaryOrganization	Text	100	No	None
Manager Primary Organization Id	ManagerPrimaryOrganizationId	Id	15	No	None
Manager UId	ManagerUId	Text	100	No	None
Middle Name	MiddleName	Text	50	No	None
Party UId	PartyUId	Text	100	No	None
Person UId	PersonUId	Text	100	No	None
Preferred Communications	PreferredCommunications	Text	30	No	Bound by OFFER_MEDIA
Status	Status	Text	30	No	Bound by CONTACT_STATUS
Work Phone #	WorkPhone	Text	40	No	None
Work Phone Extension	WorkPhoneExtension	Text	10	No	None
operation	operation	Text	30	No	System field
IC: Account
Account	Account	Text	100	Yes	None
Account Location	AccountLocation	Text	50	No	None
Account Organization	AccountOrganization	Text	100	No	None
Account Party UId	AccountPartyUId	Text	100	No	None
Account Row Id	AccountRowId	Id	15	No	None
Account Status	AccountStatus	Text	30	No	Bound by ACCOUNT_STATUS
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
Related Account Integration Id	RelatedAccountIntegrationId	Text	30	No	None
operation	operation	Text	30	No	System field
Household
Household Id	HouseholdId	Id	30	No	None
Household Integration Id	HouseholdIntegrationId	Text	30	No	None
Household Name	HouseholdName	Text	50	No	None
Household Number	HouseholdNumber	Text	100	No	None
Household Party UId	HouseholdPartyUId	Text	100	No	None
Household Status	HouseholdStatus	Text	30	No	Bound by HOUSEHOLD_STATUS
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
operation	operation	Text	30	No	System field
Organization
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
Organization	Organization	Text	50	No	None
Organization Id	OrganizationId	Id	30	No	None
Organization Integration Id	OrganizationIntegrationId	Text	30	No	None
operation	operation	Text	30	No	System field
IC: Position
Division	Division	Text	255	No	None
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
Position	Position	Text	50	No	None
Position Id	PositionId	Id		No	None
Position Integration Id	PositionIntegrationId	Text	30	No	None
Sales Rep	SalesRep	Text	50	No	None
operation	operation	Text	30	No	System field

Contact

Contact messages are used in insert, query, update, and delete operations to maintain contact information. The LookUpContact and LookUpContactByName XML tags are used for query operations. UpdateContact, InsertContact, and DeleteContact are message pairs for request and response operations. The following figure describes the structure of this message.

The following table lists the Contact Query Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContact	Contact	LookUpContact	UK1:PartyUId UK2: Id
CIFContactRs	Contact	LookUpContactResponse	UK1:PartyUId UK2: Id

The following table lists the Contact Query by Name Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactByName	Contact	LookUpContactByName	1:PartyUId2: Id
CIFContactByNameRs	Contact	LookUpContactByNameResponse	1:PartyUId2: Id

The following table lists the Contact Update Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactUpdate	Contact	UpdateContact	1UK1:PartyUId UK2: Id
CIFContactUpdateRs	Contact	UpdateContactResponse	UK1:PartyUId UK2: Id

The following table lists the Contact Insert Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactInsert	Contact	InsertContact	UK1:PartyUId UK2: Id
CIFContactInsertRs	Contact	InsertContactResponse	1:UK1:PartyUId UK2: Id: Id

The following table lists the Contact Delete Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFContactDelete	Contact	DeleteContact	UK1:PartyUId UK2: Id
CIFContactDeleteRs	Contact	DeleteContactResponse	UK1:PartyUId UK2: Id

The following table lists the Contact Integration Component and Integration Component Fields.

Name	XML Tag	Data Type	Length	Req	Comments
IC: Contact
Alias	Alias	Text	50	No	None
Assistant	Assistant	Text	50	No	None
Assistant Phone #	AssistantPhone	Text	40	No	None
Best Call Time	BestCallTime	Text	30	No	Bound by FINCORP_CONTACT_CALL_TIME
Cellular Phone #	CellularPhone	Text	40	No	None
Customer Value	CustomerValue	Text	30	No	Bound by FIN_CON_VALUE_TYPE
Date of Birth	DateofBirth	Date	7	No	None
Email Address	EmailAddress	Text	50	No	None
Email Address 2	EmailAddress2	Text	50	No	None
Fax Phone #	FaxPhone	Text	40	No	None
First Name	FirstName	Text	50	Yes	None
Home Phone #	HomePhone	Text	40	No	None
Id	Id	Id	15	Yes	This tag is required for ID cross-referencing. It stores the incoming external ID.
Income	Income	Currency	22	No	None
Income Currency Code	IncomeCurrencyCode	Text	20	No	Used for determining a related entity.
Income Exchange Date	IncomeExchangeDate	Date	7	No	None
Integration Id	IntegrationId	Text	30	No	None
Job Title	JobTitle	Text	75	No	None
Last Name	LastName	Text	50	Yes	None
M/F	MF	Text	30	No	Bound by SEX_MF
M/M	MM	Text	15	No	Bound by MR_MS
Manager First Name	ManagerFirstName	Text	50	No	None
Manager Id	ManagerId	Id	15	No	None
Manager Integration Id	ManagerIntegrationId	Text	30	No	None
Manager Last Name	ManagerLastName	Text	50	No	Used for picking a related entity
Manager Middle Name	ManagerMiddleName	Text	50	No	None
Manager Primary Organization	ManagerPrimaryOrganization	Text	100	No	None
Manager Primary Organization Id	ManagerPrimaryOrganizationId	Id	15	No	None
Manager UId	ManagerUId	Text	100	No	None
Marital Status	MaritalStatus	Text	30	No	Bound by MARITAL_STATUS
Middle Name	MiddleName	Text	50	No	None
Mother Maiden Name	MotherMaidenName	Text	50	No	None
Party UId	PartyUId	Text	100	No	None
Person UId	PersonUId	Text	100	No	None
Preferred Communications	PreferredCommunications	Text	30	No	Bound by OFFER_MEDIA
Preferred Language Code	PreferredLanguageCode	Text	20	No	None
Privacy Code	PrivacyCode	Text	30	No	Bound by PRIVACY_CODE
Social Security Number	SocialSecurityNumber	Text	11	No	None
Status	Status	Text	30	No	Bound by CONTACT_STATUS
Suppress All Calls	SuppressAllCalls	Text	1	No	None
Suppress All Emails	SuppressAllEmails	Text	1	No	None
Suppress All Faxes	SuppressAllFaxes	Text	1	No	None
Suppress All Mailings	SuppressAllMailings	Text	1	No	None
Time Zone Id	TimeZoneId	Id	15	No	None
Time Zone Name	TimeZoneName	Text	100	No	Used for picking a related entity.
Work Phone #	WorkPhone	Text	40	No	None
Work Phone Extension	WorkPhoneExtension	Text	10	No	None
operation	operation	Text	30	No	System field
IC: Account
Account	Account	Text	100	Yes	None
Account Location	AccountLocation	Text	50	No	None
Account Organization	AccountOrganization	Text	100	No	None
Account Party UId	AccountPartyUId	Text	100	No	None
Account Row Id	AccountRowId	Id	15	No	None
Account Status	AccountStatus	Text	24	No	Bound by ACCOUNT_STATUS
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
Related Account Integration Id	RelatedAccountIntegrationId	Text	30	No	None
operation	operation	Text	30	No	None
Alternate Phone
Alternate Phone #	AlternatePhone	Text	40	Yes	None
Alternate Phone Id	AlternatePhoneId	Id	15	No	None
Alternate Phone Integration Id	AlternatePhoneIntegrationId	Text	30	No	None
Alternate Phone Medium Type	AlternatePhoneMediumType	Text	30	No	None
Alternate Phone Name	AlternatePhoneName	Text	50	No	None
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
operation	operation	Text	30	No	System field
IC: Communication Address
Alternate Email Address	AlternateEmailAddress	Text	100	Yes	None
Communication Address Id	CommunicationAddressId	Id	15	No	None
Communication Address Integration Id	CommunicationAddressIntegrationId	Text	30	No	None
Communication Address Medium Type	CommunicationAddressMediumType	Text	30	No	None
Communication Address Name	CommunicationAddressName	Text	50	Yes	None
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
operation	operation	Text	30	No	System field
IC: Household
Household Id	HouseholdId	Id	15	No	None
Household Integration Id	HouseholdIntegrationId	Text	30	No	None
Household Name	HouseholdName	Text	50	No	None
Household Number	HouseholdNumber	Text	100	No	None
Household Party UId	HouseholdPartyUId	Text	100	No	None
Household Status	HouseholdStatus	Text	30	No	Bound by HOUSEHOLD_STATUS
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
operation	operation	Text	30	No	None
INS Personal Address
INS Personal Address Id	INSPersonalAddressId	Id	15	No	None
INS Personal Address Name	INSPersonalAddressName	Text	100	No	None
INS Personal Address Type	INSPersonalAddressType	Text	30	No	None
INS Personal City	INSPersonalCity	Text	50	Yes	None
INS Personal Country	INSPersonalCountry	Text	30	No	Bound by COUNTRY
INS Personal County	INSPersonalCounty	Text	50	No	None
INS Personal Integration Id	INSPersonalIntegrationId	Text	30	No	None
INS Personal Postal Code	INSPersonalPostalCode	Text	30	No	None
INS Personal State	INSPersonalState	Text	10	No	Bound by STATE_ABBREV
INS Personal Street Address	INSPersonalStreetAddress	Text	200	Yes	None
INS Personal Street Address 2	INSPersonalStreetAddress2	Text	100	No	None
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
operation	operation	Text	30	No	System field
IC: Organization
Division	Division	Text	255	No	None
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
Position	Position	Text	50	No	None
Position Id	PositionId	Id	15	No	None
Position Integration Id	PositionIntegrationId	Text	30	No	None
Sales Rep	SalesRep	Text	50	No	None
operation	operation	Text	30	No	System field
IC: Position
Division	Division	Text	255	No	None
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
operation	operation	Text	30	No	System field
Position	Position	Text	50	No	None
Position Id	PositionId	Id	15	No	None
Position Integration Id	PositionIntegrationId	Text	30	No	None
Sales Rep	SalesRep	Text	50	No	None
IC: Action
Account Id	AccountId	Id	15	No	None
Account Location	AccountLocation	Text	50	No	None
Account Name	AccountName	Text	100	No	Used for picking a related entity.
Audience	Audience	Text	30	No	Bound by ACTIVITY_AUDIENCE_TYPE
Category	Category	Text	30	No	Bound by TODO_TYPE
Description	Description	Text	100	No	None
Done	Done	UTC date time	7	No	None
Done Flag	DoneFlag	Text	1	No	None
Due	Due	UTC date time	7	No	None
Duration Minutes	DurationMinutes	Integer	22	No	Bound by APPOINTMENT_DURATION
Id	Id	Id	15	No	None
Integration Id	IntegrationId	Text	30	No	None
MeetingLocation	MeetingLocation	Text	100	No	None
No Sooner Than Date	NoSoonerThanDate	UTC date time	7	No	None
operation	operation	Text	30	No	System field
Planned	Planned	UTC date time	7	No	None.
Started	Started	UTC date time	7	No	None
Status	Status	Text	30	No	Bound by EVENT_STATUS
Type	Type	Text	30	Yes	Bound by TODO_TYPE
IC: FINCORP Account
Account Branch ABA	AccountBranchABA	Text	50	No	Used for picking a related entity.
Account Branch Id	AccountBranchId	Id	15	No	None
Account Holder	AccountHolder	Text	100	No	Used for picking a related entity.
Account Name	AccountName	Text	100	No	None
Account Number	AccountNumber3	Text	100	Yes	None
Account Status	AccountStatus2	Text	30	No	Bound by FINS_CRPST_LFLN_IPFS_PLC_MLOV
Account Type	AccountType	Text	30	No	Bound by FINCORP_PROD_ADMIN_CLASS_MLOV
Acct Gen - Branch Id	AcctGen-BranchId	Id	15	No	None
Available Balance	AvailableBalance	Currency	22	No	None
Billing Option	BillingOption	Text	30	No	Bound by FINCORP_ACCOUNT_BILL_OPTION
Branch	Branch	Text	50	No	None
Current Balance	CurrentBalance	Currency	22	No	None
Id	Id	Id	15	No	None
Integration Id	IntegrationId	Text	30	No	None
Name	Name	Text	100	Yes	Used for picking a related entity
operation	operation	Text	30	No	System field
Organization Id	OrganizationId2	Id	15	No	None
Product Id	ProductId	Id	15	Yes	None
Relationship Limit	RelationshipLimit	Currency	22	No	None
Start Date	StartDate	Date and time	7	No	None
IC: UCM Contact Privacy
Affiliate Flag	AffiliateFlag	Text	30	No	None
Affiliate Method	AffiliateMethod	Text	30	No	None
Affiliate Source	AffiliateSource	Text	30	No	None
Affiliate System	AffiliateSystem	Text	30	No	None
Channel Flag	ChannelFlag	Text	30	No	None
Channel Method	ChannelMethod	Text	30	No	None
Channel Source	ChannelSource	Text	30	No	None
Channel System	ChannelSystem	Text	30	No	None
Contact Id	ContactId	Id		No	None
Cover Letter Type	CoverLetterType	Text	30	No	None
Cover Letter Type II	CoverLetterTypeII	Text	30	No	None
Id	Id	Id	30	No	None
Integration Id	IntegrationId	Text	30	No	None
Nonaffiliate Flag	NonaffiliateFlag	Text	30	No	None
Nonaffiliate Method	NonaffiliateMethod	Text	30	No	None
Nonaffiliate Source	NonaffiliateSource	Text	30	No	None
Nonaffiliate System	NonaffiliateSystem	Text	30	No	None
Notice Send Flag	NoticeSendFlag	Text	30	No	None
Notice Sent Date	NoticeSentDate	UTC date time	Not applicable	No	None
Notice Sent Reason	NoticeSentReason	Text	100	No	None
Notice Sent Type	NoticeSentType	Text	30	No	None
OFAC Flag	OFACFlag	Boolean	Not applicable	No	None
PEND End Date	PENDEndDate	UTC date time	Not applicable	No	None
PEND Start Date	PENDStartDate	UTC date time	Not applicable	No	None
Privacy Parent Type	PrivacyParentType	Text	30	No	None
Privacy State Code	PrivacyStateCode	Text	30	No	None
Receive Annual Notice Flag	ReceiveAnnualNoticeFlag	Text	30	No	None
Receive Annual Notice Method	ReceiveAnnualNoticeMethod	Text	30	No	None
Receive Annual Notice Source	ReceiveAnnualNoticeSource	Text	30	No	None
Receive Annual Notice System	ReceiveAnnualNoticeSystem	Text	30	No	None
State PEND Period	StatePENDPeriod	Integer	Not applicable	No	None
Telemarketing Flag	TelemarketingFlag	Text	30	No	None
Telemarketing Method	TelemarketingMethod	Text	30	No	None
Telemarketing Source	TelemarketingSource	Text	30	No	None
Telemarketing System	TelemarketingSystem	Text	30	No	None
Updated	Updated	Date and time	30	No	None
Updated By	UpdatedBy	Id	30	No	None

Household

Household messages are used in insert, query, update, and delete operations to maintain Household information. LookUpHousehold and LookUpHouseholdByName are used for query operations. UpdateHousehold, InsertHousehold, and DeleteHousehold are message pairs for request and response operations. The following figure describes the structure of this message.

The following table lists the Household Query Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFHousehold	Household	LookUpHousehold	UK1:PartyUId UK2: Id
CIFHouseholdRs	Household	LookUpHouseholdResponse	UK1:PartyUId UK2: Id

The following table lists the Household Query by Name Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFHouseholdByName	Household	LookUpHouseholdByName	UK1:PartyUId UK2: Id
CIFHouseholdByNameRs	Household	LookUpHouseholdByNameResponse	UK1:PartyUId UK2: Id

The following table lists the Household Update Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFHouseholdUpdate	Household	UpdateHousehold	UK1:PartyUId UK2: Id
CIFHouseholdUpdateRs	Household	UpdateHouseholdResponse	UK1:PartyUId UK2: Id

The following table lists the Household Insert Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFHouseholdInsert	Household	InsertHousehold	UK1:PartyUId UK2: Id
CIFHouseholdInsertRs	Household	InsertHouseholdResponse	UK1:PartyUId UK2: Id

The following table lists the Household Delete Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFHouseholdDelete	Household	DeleteHousehold	UK1:PartyUId UK2: Id
CIFHouseholdDeleteRs	Household	DeleteHouseholdResponse	UK1:PartyUId UK2: Id

The following table lists the Household Integration Component and Integration Component Fields.

Name	XML Tag	Data Type	Length	Req	Comments
IC: Household
Alias	Alias	Text	50	No	None
Category	Category	Text	30	No	Bound by HOUSEHOLD_CATEGORIES
Currency Code	CurrencyCode	Text	20	No	Used for picking a related entity.
Fax Number	FaxNumber	Text	40	No	None
Household Name	HouseholdName	Text	50	No	None
Household Number	HouseholdNumber	Text	100	No	None
Household Size	HouseholdSize	Integer	22	No	None
Household Wealth	HouseholdWealth	Currency	22	No	None
Id	Id	Id	30	Yes	This tag is required for ID cross-referencing. It stores the incoming external ID.
Income	Income	Currency	7	No	None
Integration Id	IntegrationId	Text	30	No	None
Party UId	PartyUId	Text	100	No	None
Phone Number	PhoneNumber	Text	40	No	None
Privacy Code	PrivacyCode	Text	30	No	Bound by PRIVACY_CODE
Revenue	Revenue	Currency	22	No	None
Segment	Segment	Text	30	No	Bound by HOUSEHOLD_SEGMENT
Status	Status	Text	30	No	Bound by HOUSEHOLD_STATUS
Suppress All Calls	SuppressAllCalls	Text	1	No	None
Suppress All Mailings	SuppressAllMailings	Text	1	No	None
Type	Type	Text	30	No	Bound by HOUSEHOLD_TYPE
operation	operation	Text	30	No	None
IC: Contact
Contact Integration Id	ContactIntegrationId	Text	30	No	None
Contact Party UId	ContactPartyUId	Text	100	No	None
DOB	DOB	Date	7	No	None
First Name	FirstName	Text	50	Yes	None
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
Last Name	LastName	Text	50	No	None
M/M	MM	Text	15	Yes	Bound by MR_MS
Middle Name	MiddleName	Text	50	No	None
Person UId	PersonUId	Text	100	No	None
Related Contact Id	RelatedContactId	Id	15	No	None
Related Date Entered Household	RelatedDateEnteredHousehold	UTC date time	7	No	None
Related Date Exited Household	RelatedDateExitedHousehold	UTC date time	7	No	None
Related Primary Organization Id	RelatedPrimaryOrganizationId	Id	15	No	None
Relation to Household	RelationtoHousehold	Text	30	No	Bound by REL_TO_HOUSEHOLD
SSN	SSN	Text	11	No	None
operation	operation	Text	30	No	System field
IC: Household Address
Address Integration Id	AddressIntegrationId	Text	30	No	None
Address Name	AddressName	Text	100	No	None
Address Row Id	AddressRowId	Id	15	No	None
City	City	Text	50	Yes	None
Country	Country	Text	30	No	Bound by COUNTRY
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
operation	operation	Text	30	No	System field
Postal code	Postalcode	Text	30	No	None
State	State	Text	10	No	Bound by STATE_ABBREV
Street Address	StreetAddress	Text	200	Yes	None
Street Address 2	StreetAddress2	Text	100	No	None
IC: Organization
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
operation	operation	Text	30	No	System field
Organization	Organization	Text	50	No	None
Organization Id	OrganizationId	Id	30	No	None
Organization Integration Id	OrganizationIntegrationId	Text	30	No	None
IC: Position
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
operation	operation	Text	30	No	System field
Position	Position	Text	50	No	None
Position Division	PositionDivision	Text	255	No	None
Position Id	PositionId	Id	15	No	None
Position Integration Id	PositionIntegrationId	Text	30	No	None
Team	Team	Text	50	No	None

Personal Address

Personal address messages are used for requesting Personal Address information. They are a message pair for request and response operations. The following figure describes the structure of this message.

The following table lists the Personal Address Query Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFPersonalAddress	Personal Address	LookUpPersonalAddress	1: Street Address, City, State, Postal Code
CIFPersonalAddressRs	Personal Address	LookUpPersonalAddressResponse	1: Street Address, City, State, Postal Code

The following table lists the Personal Address Integration Component and Integration Component Fields.

Name	XML Tag	Data Type	Length	Req	Comments
IC: Personal Address
Address Description	AddressDescription	Text	30	No	Bound by FIN_CON_ADDRESS_DESC
Address Name	AddressName	Text	100	No	None
Address Type	AddressType	Text	30	No	Bound by FIN_CON_ADDRESS_TYPE
Apartment Number	ApartmentNumber	Text	5	No	None
City	City	Text	50	Yes	None
Country	Country	Text	30	No	Bound by COUNTRY
County	County	Text	50	No	None
Integration Id	IntegrationId	Text	30	No	None
operation	Operation	Text	30	No	System field
Postal Code	PostalCode	Text	30	No	None
State	State	Text	10	No	Bound by STATE_ABBREV
Street Address	StreetAddress	Text	200	Yes	None
Street Address 2	StreetAddress2	Text	100	No	None
Zip Code	ZipCode	Text	30	No	None

FINCORP Account

FINCORP account messages are used for requesting FINCORP Account information. They are a message pair for request and response operations. The following figure describes the structure of this message.

The following table lists the FINCORP Account Query Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFFINCORPAccount	FINCORP Account	LookUpFINCORPAccount	UK1: Account Number
CIFFINCORPAccountRs	FINCORP Account	LookUpFINCORPAccountResponse	UK1: Account Number

The following table lists the FINCORP Account Integration Component and Integration Component Fields.

Name	XML Tag	Data Type	Length	Req
IC: FINCORP Account
Account Branch ABA	AccountBranchABA	Text	50	No
Account Branch Id	AccountBranchId	Id	Not applicable	No
Account Holder	AccountHolder	Text	Not applicable	No
Account Name	AccountName	Text	100	No
Account Number	AccountNumber	Text	100	Yes
Account Status	AccountStatus	Text	30	No
Account Type	AccountType	Text	30	No
Acct Gen - Branch Id	AcctGen-BranchId	Id	Not applicable	No
Acct Gen - Primary Contact Id	AcctGen-PrimaryContactId	Id	Not applicable	No
Available Balance	AvailableBalance	Text	Not applicable	No
Billing Option	BillingOption	Text	30	No
Branch	Branch	Text	50	No
CA Next Statement Date	CANextStatementDate	Date and time	Not applicable	No
Commitment Amount	CommitmentAmount	Text	Not applicable	No
Conflict Id	ConflictId	Id	30	No
Created	Created	Date and time	30	No
Current Balance	CurrentBalance	Text	Not applicable	No
Id	Id	Id	30	No
Integration Id	IntegrationId	Text	30	No
Mod Id	ModId	Id	30	No
Name	Name	Text	100	No
operation	operation	Text	30	No
Organization Id	OrganizationId	Id	Not applicable	No
Owner Type	OwnerType	Text	30	No
Parent ABA Number	ParentABANumber	Text	50	No
Parent Asset ID	ParentAssetID	Id	Not applicable	No
Parent Asset Number	ParentAssetNumber	Text	100	No
Primary Account Id	PrimaryAccountId	Id	Not applicable	No
Product Id	ProductId	Id	Not applicable	Yes
Relationship	Relationship	Text	30	No
Relationship Limit	RelationshipLimit	Text	Not applicable	No
searchspec	searchspec	Text	250	No
Start Date	StartDate	Date and time	Not applicable	No
Sub Type	SubType	Text	30	No
Type	Type	Text	30	No
Updated	Updated	UTC date time	30	No
Updated By	UpdatedBy	Id	30	No
IC: Contact
Account Id	AccountId	Id	Not applicable	No
Account Integration Id	AccountIntegrationId	Text	30	No
Assistant	Assistant	Text	50	No
Assistant Phone #	AssistantPhone	Text	Not applicable	No
Cellular Phone #	CellularPhone	Text	Not applicable	No
Fax Phone #	FaxPhone	Text	Not applicable	No
First Name	FirstName	Text	50	No
Home Phone #	HomePhone	Text	Not applicable	No
Id	Id	Id	100	No
Integration Id	IntegrationId	Text	30	No
Job Title	JobTitle	Text	75	No
Last Name	LastName	Text	50	No
M/M	MM	Text	15	No
Market Cap Pref	MarketCapPref	Text	30	No
Middle Name	MiddleName	Text	50	No
Mod Id	ModId	Id	30	No
operation	operation	Text	30	No
Party UId	PartyUId	Text	30	No
Person UId	PersonUId	Id	30	No
Preferred Communication Method	PreferredCommunicationMethod	Text	20	No
Primary Personal Address Id	PrimaryPersonalAddressId	Id	Not applicable	No
Privacy Code	PrivacyCode	Text	30	No
searchspec	searchspec	Text	250	No
Suppress All Calls	SuppressAllCalls	Boolean	Not applicable	No
Suppress All Emails	SuppressAllEmails2	Boolean	Not applicable	No
Suppress All Faxes	SuppressAllFaxes	Boolean	Not applicable	No
Suppress All Mailings	SuppressAllMailings	Boolean	Not applicable	No
Updated	Updated	Date and time	30	No
Updated By	UpdatedBy	Id	30	No
Work Phone #	WorkPhone	Text	Not applicable	No
IC: FINCORP Account Contact
Asset Id	AssetId	Id	Not applicable	No
Contact Id	ContactId	Id	Not applicable	No
Id	Id	Id	30	No
Status	Status	Text	30	No
Updated	Updated	Date and time	30	No
Updated By	UpdatedBy	Id	30	No
IC: CUT Address
Address Name	AddressName	Text	100	Yes
City	City	Text	50	Yes
Country	Country	Text	30	No
County	County	Text	50	No
Id	Id	Id	30	No
Integration Id	IntegrationId	Text	30	No
operation	operation	Text	30	No
Postal Code	PostalCode	Text	30	No
searchspec	searchspec	Text	250	No
State	State	Text	10	No
Street Address	StreetAddress	Text	200	No
Street Address 2	StreetAddress2	Text	100	No
Updated	Updated	Date and time	30	No
Updated By	UpdatedBy	Id	30	No
IC: FINS CF Financial Account Address
Active Flag	ActiveFlag	Boolean	Not applicable	No
Addr Id	AddrId	Id	Not applicable	No
City	City	Text	50	No
Contact Id	ContactId	Id	Not applicable	No
Country	Country	Text	30	No
Fin Acct Id	FinAcctId	Id	Not applicable	No
First Name	FirstName	Text	50	No
Id	Id	Id	30	No
Last Name	LastName	Text	50	No
operation	operation	Text	30	No
searchspec	searchspec	Text	250	No
State	State	Text	10	No
Street	Street	Text	200	Yes
Updated	Updated	Date and time	30	No
Updated By	UpdatedBy	Id	30	No
Use Type	UseType	Text	30	Yes
Zipcode	Zipcode2	Text	30	No
IC: UCM Contact Privacy
Affiliate Flag	AffiliateFlag	Text	30	No
Affiliate Method	AffiliateMethod	Text	30	No
Affiliate Source	AffiliateSource	Text	30	No
Affiliate System	AffiliateSystem	Text	30	No
Channel Flag	ChannelFlag	Text	30	No
Channel Method	ChannelMethod	Text	30	No
Channel Source	ChannelSource	Text	30	No
Channel System	ChannelSystem	Text	30	No
Contact Id	ContactId	Id	Not applicable	No
Cover Letter Type	CoverLetterType	Text	30	No
Cover Letter Type II	CoverLetterTypeII	Text	30	No
Id	Id	Id	30	No
Integration Id	IntegrationId	Text	30	No
Nonaffiliate Flag	NonaffiliateFlag	Text	30	No
Nonaffiliate Method	NonaffiliateMethod	Text	30	No
Nonaffiliate Source	NonaffiliateSource	Text	30	No
Nonaffiliate System	NonaffiliateSystem	Text	30	No
Notice Send Flag	NoticeSendFlag	Text	30	No
Notice Sent Date	NoticeSentDate	UTC date time	Not applicable	No
Notice Sent Reason	NoticeSentReason	Text	100	No
Notice Sent Type	NoticeSentType	Text	30	No
OFAC Flag	OFACFlag	Boolean	Not applicable	No
PEND End Date	PENDEndDate	UTC date time	Not applicable	No
PEND Start Date	PENDStartDate	UTC date time	Not applicable	No
Privacy Parent Type	PrivacyParentType	Text	30	Yes
Privacy State Code	PrivacyStateCode	Text	30	No
Receive Annual Notice Flag	ReceiveAnnualNoticeFlag	Text	30	No
Receive Annual Notice Method	ReceiveAnnualNoticeMethod	Text	30	No
Receive Annual Notice Source	ReceiveAnnualNoticeSource	Text	30	No
Receive Annual Notice System	ReceiveAnnualNoticeSystem	Text	30	No
State PEND Period	StatePENDPeriod	Integer	Not applicable	No
Telemarketing Flag	TelemarketingFlag	Text	30	No
Telemarketing Method	TelemarketingMethod	Text	30	No
Telemarketing Source	TelemarketingSource	Text	30	No
Telemarketing System	TelemarketingSystem	Text	30	No
Updated	Updated	Date and time	30	No
Updated By	UpdatedBy	Id	30	No
IC: UCM FINCORP Account Contact Address
Address Type	AddressType	Text	30	No
City	City	Text	50	No
Comments	Comments	Text	200	No
Country	Country	Text	30	No
Financial Account Contact Id	FinancialAccountContactId	Id	Not applicable	No
Id	Id	Id	30	No
operation	operation	Text	30	No
Personal Address Id	PersonalAddressId	Id	Not applicable	Yes
Postal Code	PostalCode	Text	30	No
searchspec	searchspec	Text	250	No
State	State	Text	10	No
Street Address	StreetAddress	Text	200	No
Street Address 2	StreetAddress2	Text	200	No
Updated	Updated	Date and time	30	No
Updated By	UpdatedBy	Id	30	No
IC: UCM FINCORP Account Contact Privacy
Affiliate Flag	AffiliateFlag	Text	30	No
Affiliate Method	AffiliateMethod	Text	30	No
Affiliate Source	AffiliateSource	Text	30	No
Affiliate System	AffiliateSystem	Text	30	No
Channel Flag	ChannelFlag	Text	30	No
Channel Method	ChannelMethod	Text	30	No
Channel Source	ChannelSource	Text	30	No
Channel System	ChannelSystem	Text	30	No
Cover Letter Type	CoverLetterType	Text	30	No
Cover Letter Type II	CoverLetterTypeII	Text	30	No
Financial Account Contact Id	FinancialAccountContactId	Id	Not applicable	No
Financial Account Id	FinancialAccountId	Id		No
Id	Id	Id	30	No
Integration Id	IntegrationId	Text	30	No
Nonaffiliate Flag	NonaffiliateFlag	Text	30	No
Nonaffiliate Method	NonaffiliateMethod	Text	30	No
Nonaffiliate Source	NonaffiliateSource	Text	30	No
Nonaffiliate System	NonaffiliateSystem	Text	30	No
Notice Send Flag	NoticeSendFlag	Text	30	No
Notice Sent Date	NoticeSentDate	UTC date time	Not applicable	No
Notice Sent Reason	NoticeSentReason	Text	100	No
Notice Sent Type	NoticeSentType	Text	30	No
OFAC Flag	OFACFlag	Boolean	Not applicable	No
operation	operation	Text	30	No
PEND Flag	PENDFlag	Boolean	Not applicable	No
Privacy Parent Type	PrivacyParentType	Text	30	Yes
Privacy State Code	PrivacyStateCode	Text	30	No
Receive Annual Notice Flag	ReceiveAnnualNoticeFlag	Text	30	No
Receive Annual Notice Method	ReceiveAnnualNoticeMethod	Text	30	No
Receive Annual Notice Source	ReceiveAnnualNoticeSource	Text	30	No
Receive Annual Notice System	ReceiveAnnualNoticeSystem	Text	30	No
searchspec	searchspec	Text	250	No
Telemarketing Flag	TelemarketingFlag	Text	30	No
Telemarketing Method	TelemarketingMethod	Text	30	No
Telemarketing Source	TelemarketingSource	Text	30	No
Telemarketing System	TelemarketingSystem	Text	30	No
Updated	Updated	Date and time	30	No
Updated By	UpdatedBy	Id	30	No
IC: UCM FINCORP Account Privacy
Affiliate Flag	AffiliateFlag	Text	30	No
Affiliate Method	AffiliateMethod	Text	30	No
Affiliate Source	AffiliateSource	Text	30	No
Affiliate System	AffiliateSystem	Text	30	No
Channel Flag	ChannelFlag	Text	30	No
Channel Method	ChannelMethod	Text	30	No
Channel Source	ChannelSource	Text	30	No
Channel System	ChannelSystem	Text	30	No
Cover Letter Type	CoverLetterType	Text	30	No
Cover Letter Type II	CoverLetterTypeII	Text	30	No
Financial Account Id	FinancialAccountId	Id		No
Id	Id	Id	30	No
Integration Id	IntegrationId	Text	30	No
Nonaffiliate Flag	NonaffiliateFlag	Text	30	No
Nonaffiliate Method	NonaffiliateMethod	Text	30	No
Nonaffiliate Source	NonaffiliateSource	Text	30	No
Nonaffiliate System	NonaffiliateSystem	Text	30	No
Notice Send Flag	NoticeSendFlag	Text	30	No
Notice Sent Date	NoticeSentDate	UTC date time	Not applicable	No
Notice Sent Reason	NoticeSentReason	Text	100	No
Notice Sent Type	NoticeSentType	Text	30	No
OFAC Flag	OFACFlag	Boolean		No
operation	operation	Text	30	No
PEND Start Date	PENDStartDate	UTC date time	Not applicable	No
Privacy Parent Type	PrivacyParentType	Text	30	Yes
Privacy State Code	PrivacyStateCode	Text	30	No
Receive Annual Notice Flag	ReceiveAnnualNoticeFlag	Text	30	No
Receive Annual Notice Method	ReceiveAnnualNoticeMethod	Text	30	No
Receive Annual Notice Source	ReceiveAnnualNoticeSource	Text	30	No
Receive Annual Notice System	ReceiveAnnualNoticeSystem	Text	30	No
searchspec	searchspec	Text	250	No
State PEND Period	StatePENDPeriod	Integer	Not applicable	No
Telemarketing Flag	TelemarketingFlag	Text	30	No
Telemarketing Method	TelemarketingMethod	Text	30	No
Telemarketing Source	TelemarketingSource	Text	30	No
Telemarketing System	TelemarketingSystem	Text	30	No
Updated	Updated	Date and time	30	No
Updated By	UpdatedBy	Id	30	No

Account Profile

Account profile messages are used in insert, query, update, and delete operations to maintain account profile information. LookUpAccount Profile and LookUptProfileByName are used for query operations. UpdateAccountProfile, InsertAccountProfile, and DeleteAccountProfile are message pairs for request and response operations. The following figure describes the structure of this message.

The following table lists the Account Profile Query Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountProfile	Account	LookUpAccountProfile	UK1:PartyUId UK2: Id
CIFAccountProfileRs	Account	LookUpAccountProfileResponse	UK1:PartyUId UK2: Id

The following table lists the Account Profile Query by Name Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountProfileByName	Account	LookUpAccountProfileByName	UK1:PartyUIdUK2: Id
CIFAccountProfileByNameRs	Account	LookUpAccountProfileByNameResponse	UK1:PartyUIdUK2: Id

The following table lists the Account Profile Update Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountProfileUpdate	Account	UpdateAccountProfile	UK1:PartyUIdUK2: Id
CIFAccountProfileUpdateRs	Account	UpdateAccountProfileResponse	UK1:PartyUIdUK2: Id

The following table lists the Account Profile Insert Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountProfileInsert	Account	InsertAccountProfile	UK1:PartyUIdUK2: Id
CIFAccountProfileInsertRs	Account	InsertAccountProfileResponse	UK1:PartyUIdUK2: Id

The following table lists the Account Profile Delete Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountProfileInsert	Account	DeleteAccountProfile	UK1:PartyUIdUK2: Id
CIFAccountProfileInsertRs	Account	DeleteAccountProfileResponse	UK1:PartyUIdUK2: Id

The following table lists the Account Profile Integration Component and Integration Component Fields.

Name	XML Tag	Data Type	Length	Req	Notes
Account Region	AccountRegion	Text	30	No	Use for choosing a related entity
Account Status	AccountStatus	Text	24	No	Bound by ACCOUNT_STATUS
Account Type Code	AccountTypeCode	Text	30	Yes	Bound by CUT_ACCOUNT_TYPE
Account Value	AccountValue	Text	30	No	Bound by FIN_CON_VALUE_TYPE
Alias	Alias	Text	50	No	None
Annual Revenue	AnnualRevenue	Text	22	No	None
Client Flag	ClientFlag	Boolean	1	No	None
Competitor	Competitor	Boolean	1	No	None
Credit Agency Number	CreditAgencyNumber	Text	30	No	None
Cumulative Sales	CumulativeSales	Number	22	No	None
Currency Code	CurrencyCode	Text	15	Yes	None
Current Volume	CurrentVolume	Currency	22	No	None
Dont Call	DontCall	Boolean	1	No	None
Drug Spent Currency Code	DrugSpentCurrencyCode	Text	30	Yes	Use for picking a related entity
Employees	Employees	Number	22	No	None
Facility Flag	FacilityFlag	Boolean	1	No	None
Federal Tax Number	FederalTaxNumber	Text	15	No	None
Financing Method	FinancingMethod	Text	30	No	Bound by FINCORP_CLIENT_FINANCING
Gross Potential Value	GrossPotentialValue	Currency	22	No	None
Group Type Code	GroupTypeCode	Text	30	Yes	Bound by GROUP_TYPE_CD
Home Page	HomePage	Text	100	No	None
Id	Id	Id	15	No	Use for cross-referencing
Integration Id	IntegrationId	Text	30	No	None
Internal Org Flag	InternalOrgFlag	Boolean	1	Yes	None
Investor Flag	InvestorFlag	Boolean	1	No	None
Last Year Sales	LastYearSales	Currency	22	No	None
Legal Status	LegalStatus	Text	30	No	Bound by UT_LEGAL_STATUS
Location	Location	Text	50	No	None
Main Fax Number	MainFaxNumber	Phone	40	No	None
Main Phone Number	MainPhoneNumber	Phone	40	No	None
Master Account Id	MasterAccountId	Id	15	No	None
Name	Name	Text	100	Yes	None
operation	operation	Text	30	No	None
Partner Flag	PartnerFlag	Boolean	1	No	None
Party UId	PartyUId	Text	100	Yes	None
Privacy Code	PrivacyCode	Text	30	Yes	Bound by PRIVACY_CODE
Reference Flag	ReferenceFlag	Boolean	1	No	None
Referenciable	Referenciable	Boolean	1	No	None
Revenue Growth	RevenueGrowth	Number	22	No	None
Service Provider Flag	ServiceProviderFlag	Text	1	No	None
Status	Status	Text	30	No	Bound by FINS_COMPETITOR_STATUS_MLOV
Total # Meters	TotalMeters	Number	22	No	None
Total Potential Volume	TotalPotentialVolume	Currency	22	No	None
Type	Type	Text	30	Yes	Bound by ACCOUNT_TYPE
Unionized	Unionized	Boolean	1	No	None
YTD Net Contribution	YTDNetContribution	Currency	22	No	None

Account Address

Account address messages are used in insert, query, update, and delete operations to maintain account address information. LookUpAccount Address and LookUpAccountAddressByName are used for query operations. UpdateAccountAddress, InsertAccountAddress, and DeleteAccountAddress are message pairs for request and response operations. The following figure describes the structure of this message.

The following table lists the Account Address Query Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountAddress	Account	LookUpAccountAddress	UK1:PartyUId UK2: Id
CIFAccountAddressRs	Account	LookUpAccountAddressResponse	UK1:PartyUId UK2: Id

The following table lists the Account Address Query by Name Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountAddressByName	Account	LookUpAccountAddressByName	UK1:PartyUIdUK2: Id
CIFAccountAddressByNameRs	Account	LookUpAccountAddressByNameResponse	UK1:PartyUIdUK2: Id

The following table lists the Account Address Update Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountAddressUpdate	Account	UpdateAccountAddress	UK1:PartyUId UK2: Id
CIFAccountAddressUpdateRs	Account	UpdateAccountAddressResponse	UK1:PartyUId UK2: Id

The following table lists the Account Address Insert Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountAddressInsert	Account	InsertAccountAddress	UK1:PartyUIdUK2: Id
CIFAccountAddressInsertRs	Account	InsertAccountAddressResponse	UK1:PartyUIdUK2: Id

The following table lists the Account Address Delete Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountAddressDelete	Account	DeleteAccountAddress	UK1:PartyUId UK2: Id
CIFAccountAddressDeleteRs	Account	DeleteAccountAddressResponse	UK1:PartyUId UK2: Id

The following table lists the Account Address Integration Component and Integration Component Fields.

Name	XML Tag	Data Type	Length	Req	Notes
IC: Account
Account Region	AccountRegion	Text	30	No	Use for picking a related entity
Account Status	AccountStatus	Text	24	No	Bound by ACCOUNT_STATUS
Account Type Code	AccountTypeCode	Text	30	Yes	Bound by CUT_ACCOUNT_TYPE
Account Value	AccountValue	Text	30	No	Bound by FIN_CON_VALUE_TYPE
Alias	Alias	Text	50	No	None
Annual Revenue	AnnualRevenue	Text	22	No	None
Client Flag	ClientFlag	Boolean	1	No	None
Competitor	Competitor	Boolean	1	No	None
Credit Agency Number	CreditAgencyNumber	Text	30	No	None
Cumulative Sales	CumulativeSales	Number	22	No	None
Currency Code	CurrencyCode	Text	15	Yes	None
Current Volume	CurrentVolume	Currency	22	No	None
Dont Call	DontCall	Boolean	1	No	None
Drug Spent Currency Code	DrugSpentCurrencyCode	Text	30	Yes	Use for picking a related entity
Employees	Employees	Number	22	No	None
Facility Flag	FacilityFlag	Boolean	1	No	None
Federal Tax Number	FederalTaxNumber	Text	15	No	None
Financing Method	FinancingMethod	Text	30	No	Bound by FINCORP_CLIENT_FINANCING
Gross Potential Value	GrossPotentialValue	Currency	22	No	None
Group Type Code	GroupTypeCode	Text	30	Yes	Bound by GROUP_TYPE_CD
Home Page	HomePage	Text	100	No	None
Integration Id	IntegrationId	Text	30	No	None
Internal Org Flag	InternalOrgFlag	Boolean	1	Yes	None
Investor Flag	InvestorFlag	Boolean	1	No	None
Last Year Sales	LastYearSales	Currency	22	No	None
Legal Status	LegalStatus	Text	30	No	Bound by UT_LEGAL_STATUS
Location	Location	Text	50	No	None
Main Fax Number	MainFaxNumber	Phone	40	No	None
Main Phone Number	MainPhoneNumber	Phone	40	No	None
Master Account Id	MasterAccountId	Id	15	No	None
Name	Name	Text	100	Yes	None
Partner Flag	PartnerFlag	Boolean	1	No	None
Party UId	PartyUId	Text	100	Yes	None
Privacy Code	PrivacyCode	Text	30	Yes	Bound by PRIVACY_CODE
Reference Flag	ReferenceFlag	Boolean	1	No	None
Referenciable	Referenciable	Boolean	1	No	None
Revenue Growth	RevenueGrowth	Number	22	No	None
Service Provider Flag	ServiceProviderFlag	Text	1	No	None
Status	Status	Text	30	No	Bound by FINS_COMPETITOR_STATUS_MLOV
Total # Meters	TotalMeters	Number	22	No	None
Total Potential Volume	TotalPotentialVolume	Currency	22	No	None
Type	Type	Text	30	Yes	Bound by ACCOUNT_TYPE
Unionized	Unionized	Boolean	1	No	None
YTD Net Contribution	YTDNetContribution	Currency	22	No	None
operation	operation	Text	30	No	None
Id	Id	Id	15	No	For cross-referencing
IC: Account_Business Address
Address Id	AddressId	Id	30	Yes	None
Address Integration Id	AddressIntegrationId	Text	30	No	None
Bill Address Flag	BillAddressFlag	Text	1	No	None
City	City	Text	50	No	None
Country	Country	Text	50	No	Use it for picking a related entity
Email Address	EmailAddress	Text	50	No	None
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
operation	operation	Text	30	No	None
Postal Code	PostalCode	Text	30	No	None
searchspec	searchspec	Text	250	No	None
Ship Address Flag	ShipAddressFlag	Text	1	No	None
State	State	Text	10	No	Bound by STATE_ABBREV
Street Address	StreetAddress	Text	200	No	None

Account Activity

Account activity messages are used in insert, query, update, and delete operations to maintain Account Activity Information. LookUpAccountActivity and LookUpAccountActivityByName are used for query operations. UpdateAccountActivity, InsertAccountActivity, and DeleteAccountActivity are message pairs for request and response operations. The following figure describes the structure of this message.

The following table lists the Account Activity Query Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountActivity	Account	LookUpAccountActivity	UK1:PartyUId UK2: Id
CIFAccountActivityRs	Account	LookUpAccountActivityResponse	UK1:PartyUId UK2: Id

The following table lists the Account Activity Query by Name Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountActivityByName	Account	LookUpAccountActivityByNames	UK1:PartyUId UK2: Id
CIFAccountActivityByNameRs	Account	LookUpAccountActivityByNameResponse	UK1:PartyUId UK2: Id

The following table lists the Account Activity Update Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountActivityUpdate	Account	UpdateAccountActivitys	UK1:PartyUId UK2: Id
CIFAccountActivityUpdateRs	Account	UpdateAccountActivityResponse	UK1:PartyUId UK2: Id

The following table lists the Account Activity Insert Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountActivityInsert	Account	InsertAccountActivity	UK1:PartyUIdUK2: Id
CIFAccountActivityInsertRs	Account	InsertAccountActivityResponse	UK1:PartyUIdUK2: Id

The following table lists the Account Activity Delete Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountActivityDelete	Account	DeleteAccountActivity	UK1:PartyUIdUK2: Id
CIFAccountActivityDeleteRs	Account	DeleteAccountActivityResponse	UK1:PartyUIdUK2: Id

The following table lists the Account Activity Integration Component and Integration Component Fields.

Name	XML Tag	Type	Length	Req	Notes
IC: Account
Account Region	AccountRegion	Text	30	No	Use for picking a related entity
Account Status	AccountStatus	Text	24	No	Bound by ACCOUNT_STATUS
Account Type Code	AccountTypeCode	Text	30	Yes	Bound by CUT_ACCOUNT_TYPE
Account Value	AccountValue	Text	30	No	Bound by FIN_CON_VALUE_TYPE
Alias	Alias	Text	50	No	None
Annual Revenue	AnnualRevenue	Text	22	No	None
Client Flag	ClientFlag	Boolean	1	No	None
Competitor	Competitor	Boolean	1	No	None
Credit Agency Number	CreditAgencyNumber	Text	30	No	None
Cumulative Sales	CumulativeSales	Number	22	No	None
Currency Code	CurrencyCode	Text	15	Yes	None
Current Volume	CurrentVolume	Currency	22	No	None
Dont Call	DontCall	Boolean	1	No	None
Drug Spent Currency Code	DrugSpentCurrencyCode	Text	30	Yes	Use for picking a related entity
Employees	Employees	Number	22	No	None
Facility Flag	FacilityFlag	Boolean	1	No	None
Federal Tax Number	FederalTaxNumber	Text	15	No	None
Financing Method	FinancingMethod	Text	30	No	Bound by FINCORP_CLIENT_FINANCING
Gross Potential Value	GrossPotentialValue	Currency	22	No	None
Group Type Code	GroupTypeCode	Text	30	Yes	Bound by GROUP_TYPE_CD
Home Page	HomePage	Text	100	No	None
Integration Id	IntegrationId	Text	30	No	None
Internal Org Flag	InternalOrgFlag	Boolean	1	Yes	None
Investor Flag	InvestorFlag	Boolean	1	No	None
Last Year Sales	LastYearSales	Currency	22	No	None
Legal Status	LegalStatus	Text	30	No	Bound by UT_LEGAL_STATUS
Location	Location	Text	50	No	None
Main Fax Number	MainFaxNumber	Phone	40	No	None
Main Phone Number	MainPhoneNumber	Phone	40	No	None
Master Account Id	MasterAccountId	Id	15	No	None
Name	Name	Text	100	Yes	None
Partner Flag	PartnerFlag	Boolean	1	No	None
Party UId	PartyUId	Text	100	Yes	None
Privacy Code	PrivacyCode	Text	30	Yes	Bound by PRIVACY_CODE
Reference Flag	ReferenceFlag	Boolean	1	No	None
Referenciable	Referenciable	Boolean	1	No	None
Revenue Growth	RevenueGrowth	Number	22	No	None
Service Provider Flag	ServiceProviderFlag	Text	1	No	None
Status	Status	Text	30	No	Bound by FINS_COMPETITOR_STATUS_MLOV
Total # Meters	TotalMeters	Number	22	No	None
Total Potential Volume	TotalPotentialVolume	Currency	22	No	None
Type	Type	Text	30	Yes	Bound by ACCOUNT_TYPE
Unionized	Unionized	Boolean	1	No	None
YTD Net Contribution	YTDNetContribution	Currency	22	No	None
operation	operation	Text	30	No	None
Id	Id	Id	15	No	For cross-referencing
IC: Action
Alarm	Alarm	Boolean	1	No	None
Assignment Excluded	AssignmentExcluded	Boolean	1	No	None
Associated Cost	AssociatedCost	Currency	22	No	None
Billable Flag	BillableFlag	Boolean	1	No	None
Call Id	CallId	Text	30	No	None
Category	Category	Text	30	Yes	Use for picking a related entity
Class	Class	Text	30	No	Bound by FS_ACTIVITY_CLASS
Comment	Comment	Text	1,500	No	None
Description	Description	Text	100	No	None
Display	Display	Text	30	No	None
Done	Done	UTC date time	7	No	None
Done Flag	DoneFlag	Boolean	1	No	None
Due	Due	UTC date time	7	No	None
Duration Minutes	DurationMinutes	Integer	22	No	Bound by APPOINTMENT_DURATION
Expense Related Flag	ExpenseRelatedFlag	Boolean	1	No	None
Id	Id	Text	100	Yes	None
Integration Id	IntegrationId	Text	30	No	None
No Sooner Than Date	NoSoonerThanDate	UTC date time	7	No	None
Objective	Objective	Text	30	No	None
operation	operation	Text	30	No	None
Owned By	OwnedBy	Text	30	Yes	Use it for picking a related entity
Owned By Id	OwnedById	Text	30	Yes	None
Primary Owned By	PrimaryOwnedBy	Text	50	No	Use it for picking a related entity
Primary Owner Id	PrimaryOwnerId	Id	30	No	None
Priority	Priority	Text	30	No	Bound by ACTIVITY_PRIORITY
Private	Private	Boolean	1	No	None
Repeating	Repeating	Boolean	1	No	None
Repeating Expires	RepeatingExpires	Date and time	7	No	None
searchspec	searchspec	Text	250	No	None
Status	Status	Text	30	No	Bound by EVENT_STATUS
Type	Type2	Text	30	Yes	Bound by TODO_TYPE
IC: Action_Contact
Company Identifier	CompanyIdentifier	Text	15	No	None
Contact First Name	ContactFirstName	Text	50	Yes	None
Contact Last Name	ContactLastName	Text	50	Yes	None
Employee Number	EmployeeNumber	Text	30	No	None
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
operation	operation	Text	30	No	None
Personal Contact	PersonalContact	Boolean	1	No	None
searchspec	searchspec	Text	250	No	None
IC: Action_Employee
Emp #	Emp	Text	30	No	None
Employee First Name (MM)	EmployeeFirstNameMM	Text	50	Yes	None
Employee Job Title (MM)	EmployeeJobTitleMM	Text	75	No	None
Employee Last Name (MM)	EmployeeLastNameMM	Text	50	Yes	None
Employee Login Name (MM)	EmployeeLoginNameMM	Text	50	Yes	None
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
operation	operation	Text	30	No	None
Private	Private	Boolean	1	Yes	None
searchspec	searchspec	Text	250	No	None

Account Product

Account products messages are used in insert, query, update, and delete operations to maintain Account Product (Financial Account) Information. LookUpAccountProduct and LookUpAccountProductByName are used for query operations. UpdateAccountProduct, InsertAccountProduct, and DeleteAccountProduct are message pairs for request and response operations. The following figure describes the structure of this message.

The following table lists the Account Product Query Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountProduct	Account	LookUpAccountProduct	UK1:PartyUId UK2: Id
CIFAccountProductRs	Account	LookUpAccountProductResponse	UK1:PartyUId UK2: Id

The following table lists the Account Product Query by Name Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountProductByName	Account	LookUpAccountProductByName	UK1:PartyUIdUK2: Id
CIFAccountProductByNameRs	Account	LookUpAccountProductByNameResponse	UK1:PartyUIdUK2: Id

The following table lists the Account Product Update Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountProductUpdate	Account	UpdateAccountProduct	UK1:PartyUId UK2: Id
CIFAccountProductUpdateRs	Account	UpdateAccountProductResponse	UK1:PartyUId UK2: Id

The following table lists the Account Product Insert Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountProductInsert	Account	InsertAccountProduct	UK1:PartyUIdUK2: Id
CIFAccountProductInsertRs	Account	InsertAccountProductResponse	UK1:PartyUIdUK2: Id

The following table lists the Account Product Delete Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountProductDelete	Account	DeleteAccountProduct	UK1:PartyUIdUK2: Id
CIFAccountProductDeleteRs	Account	DeleteAccountProductResponse	UK1:PartyUIdUK2: Id

The following table lists the Account Product Integration Component and Integration Component Fields.

Name	XML Tag	Data Type	Length	Req	Notes
IC: Account
Account Region	AccountRegion	Text	30	No	Use for picking a related entity
Account Status	AccountStatus	Text	24	No	Bound by ACCOUNT_STATUS
Account Type Code	AccountTypeCode	Text	30	Yes	Bound by CUT_ACCOUNT_TYPE
Account Value	AccountValue	Text	30	No	Bound by FIN_CON_VALUE_TYPE
Alias	Alias	Text	50	No	None
Annual Revenue	AnnualRevenue	Text	22	No	None
Client Flag	ClientFlag	Boolean	1	No	None
Competitor	Competitor	Boolean	1	No	None
Credit Agency Number	CreditAgencyNumber	Text	30	No	None
Cumulative Sales	CumulativeSales	Number	22	No	None
Currency Code	CurrencyCode	Text	15	Yes	None
Current Volume	CurrentVolume	Currency	22	No	None
Dont Call	DontCall	Boolean	1	No	None
Drug Spent Currency Code	DrugSpentCurrencyCode	Text	30	Yes	Use for picking a related entity
Employees	Employees	Number	22	No	None
Facility Flag	FacilityFlag	Boolean	1	No	None
Federal Tax Number	FederalTaxNumber	Text	15	No	None
Financing Method	FinancingMethod	Text	30	No	Bound by FINCORP_CLIENT_FINANCING
Gross Potential Value	GrossPotentialValue	Currency	22	No	None
Group Type Code	GroupTypeCode	Text	30	Yes	Bound by GROUP_TYPE_CD
Home Page	HomePage	Text	100	No
Id	Id	Id	15	No	For cross-referencing
Integration Id	IntegrationId	Text	30	No	None
Internal Org Flag	InternalOrgFlag	Boolean	1	Yes	None
Investor Flag	InvestorFlag	Boolean	1	No	None
Last Year Sales	LastYearSales	Currency	22	No	None
Legal Status	LegalStatus	Text	30	No	Bound by UT_LEGAL_STATUS
Location	Location	Text	50	No	None
Main Fax Number	MainFaxNumber	Phone	40	No	None
Main Phone Number	MainPhoneNumber	Phone	40	No	None
Master Account Id	MasterAccountId	Id	15	No	None
Name	Name	Text	100	No	None
operation	operation	Text	30	No	None
Partner Flag	PartnerFlag	Boolean	1	No	None
Party UId	PartyUId	Text	100	Yes	None
Privacy Code	PrivacyCode	Text	30	Yes	Bound by PRIVACY_CODE
Reference Flag	ReferenceFlag	Boolean	1	No	None
Referenciable	Referenciable	Boolean	1	No	None
Revenue Growth	RevenueGrowth	Number	22	No	None
Service Provider Flag	ServiceProviderFlag	Text	1	No	None
Status	Status	Text	30	No	Bound by FINS_COMPETITOR_STATUS_MLOV
Total # Meters	TotalMeters	Number	22	No	None
Total Potential Volume	TotalPotentialVolume	Currency	22	No	None
Type	Type	Text	30	No	Bound by ACCOUNT_TYPE
Unionized	Unionized	Boolean	1	No	None
YTD Net Contribution	YTDNetContribution	Currency	22	No	None
IC: FINCORP Deposit Account
Account Branch Number	AccountBranchNumber	Text	100	No	None
Account Category	AccountCategory	Text	30	No	Bound by FINS_ASSET_PROD_CLASS_MLOV
Account Number	AccountNumber	Text	100	Yes	None
Account Status	AccountStatus	Text	30	No	Bound by FINS_CRPST_LFLN_IPFS_PLC_MLOV
Branch	Branch	Text	50	No	None
Current Balance	CurrentBalance	Currency	22	No	None
Id	Id	Text	100	No	None
Integration Id	Integration Id	Text	30	No	None
Name	Name	Text	100	Yes	Use it for picking a related entity
operation	operation	Text	30	No	None
Product Id	ProductId	Id	100	Yes	None
searchspec	searchspec	Text	250	No	None
Type	Type	Text	30	No	Bound by FINS_OWNERSHIP_TYPE_MLOV
IC: FINCORP Loan Account
Account Branch Number	AccountBranchNumber	Text	30	No	None
Account Category	AccountCategory	Text	30	No	Bound by FINS_ASSET_PROD_CLASS_MLOV
Account Number	AccountNumber	Text	100	Yes	None
Account Status	AccountStatus	Text	30	No	Bound by FINS_CRPST_LFLN_IPFS_PLC_MLOV
Current Balance	CurrentBalance	Currency	22	No	None
Id	Id	Text	30	No	None
Integration Id	IntegrationId	Text	30	No	None
Name	Name	Text	100	Yes	Use it for picking a related entity
operation	operation	Text	30	No	None
Product Id	ProductId	Id	100	Yes	Use it for picking a related entity
searchspec	searchspec	Text	250	No	None
Type	Type	Text	30	No	FINS_OWNERSHIP_TYPE_MLOV

Account Relationship

Account relationship messages are used in insert, query, update, and delete operations to maintain Account Relationships. LookUpAccountRelationship and LookUpAccountRelationshipByName are used for query operations. UpdateAccountRelationship, InsertAccountRelationship, and DeleteAccountRelationship are message pairs for request and response operations. The following figure describes the structure of this message.

The following table lists the Account Relationship Query Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountRelationship	Account	LookUpAccountRelationship	UK1:PartyUIdUK2: Id
CIFAccountRelationshipRs	Account	LookUpAccountRelationshipResponse	UK1:PartyUIdUK2: Id

The following table lists the Account Relationship Query by Name Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountRelationshipByName	Account	LookUpAccountRelationshipByName	UK1:PartyUIdUK2: Id
CIFAccountRelationshipByNameRs	Account	LookUpAccountRelationshipByNameResponse	UK1:PartyUIdUK2: Id

The following table lists the Account Relationship Update Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountRelationshipUpdate	Account	UpdateAccountRelationship	UK1:PartyUIdUK2: Id
CIFAccountRelationshipUpdateRs	Account	UpdateAccountRelationshipResponse	UK1:PartyUIdUK2: Id

The following table lists the Account Relationship Insert Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountRelationshipInsert	Account	InsertAccountRelationship	UK1:PartyUIdUK2: Id
CIFAccountRelationshipInsertRs	Account	InsertAccountRelationshipResponse	UK1:PartyUIdUK2: Id

The following table lists the Account Relationship Delete Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountRelationshipDelete	Account	DeleteAccountRelationship	UK1:PartyUIdUK2: Id
CIFAccountRelationshipDeleteRs	Account	DeleteAccountRelationshipResponse	UK1:PartyUIdUK2: Id

The following table lists the Account Relationship Integration Component and Integration Component Fields.

Name	XML Tag	Data Type	Length	Req	Notes
IC: Account
Account Region	AccountRegion	Text	30	No	Use for picking a related entity
Account Status	AccountStatus	Text	24	No	Bound by ACCOUNT_STATUS
Account Type Code	AccountTypeCode	Text	30	Yes	Bound by CUT_ACCOUNT_TYPE
Account Value	AccountValue	Text	30	No	Bound by FIN_CON_VALUE_TYPE
Alias	Alias	Text	50	No	None
Annual Revenue	AnnualRevenue	Text	22	No	None
Client Flag	ClientFlag	Boolean	1	No	None
Competitor	Competitor	Boolean	1	No	None
Credit Agency Number	CreditAgencyNumber	Text	30	No	None
Cumulative Sales	CumulativeSales	Number	22	No	None
Currency Code	CurrencyCode	Text	15	Yes	None
Current Volume	CurrentVolume	Currency	22	No	None
Dont Call	DontCall	Boolean	1	No	None
Drug Spent Currency Code	DrugSpentCurrencyCode	Text	30	Yes	Use for picking a related entity
Employees	Employees	Number	22	No	None
Facility Flag	FacilityFlag	Boolean	1	No	None
Federal Tax Number	FederalTaxNumber	Text	15	No	None
Financing Method	FinancingMethod	Text	30	No	Bound by FINCORP_CLIENT_FINANCING
Gross Potential Value	GrossPotentialValue	Currency	22	No	None
Group Type Code	GroupTypeCode	Text	30	Yes	Bound by GROUP_TYPE_CD
Home Page	HomePage	Text	100	No	None
Id	Id	Id	15	No	For cross-referencing
Integration Id	IntegrationId	Text	30	No	None
Internal Org Flag	InternalOrgFlag	Boolean	1	Yes	None
Investor Flag	InvestorFlag	Boolean	1	No	None
Last Year Sales	LastYearSales	Currency	22	No	None
Legal Status	LegalStatus	Text	30	No	Bound by UT_LEGAL_STATUS
Location	Location	Text	50	No	None
Main Fax Number	MainFaxNumber	Phone	40	No	None
Main Phone Number	MainPhoneNumber	Phone	40	No	None
Master Account Id	MasterAccountId	Id	15	No	None
Name	Name	Text	100	Yes	None
operation	operation	Text	30	No	None
Partner Flag	PartnerFlag	Boolean	1	No	None
Party UId	PartyUId	Text	100	Yes	None
Privacy Code	PrivacyCode	Text	30	Yes	Bound by PRIVACY_CODE
Reference Flag	ReferenceFlag	Boolean	1	No	None
Referenciable	Referenciable	Boolean	1	No	None
Revenue Growth	RevenueGrowth	Number	22	No	None
Service Provider Flag	ServiceProviderFlag	Text	1	No	None
Status	Status	Text	30	No	Bound by FINS_COMPETITOR_STATUS_MLOV
Total # Meters	TotalMeters	Number	22	No	None
Total Potential Volume	TotalPotentialVolume	Currency	22	No	None
Type	Type	Text	30	No	Bound by ACCOUNT_TYPE
Unionized	Unionized	Boolean	1	No	None
YTD Net Contribution	YTDNetContribution	Currency	22	No	None
IC: Contact
Account Id	AccountId	Id	30	No	None
Account Integration Id	AccountIntegrationId	Text	30	No	None
Assistant	Assistant	Text	50	No	None
Assistant Phone #	AssistantPhone	Phone	40	No	None
Cellular Phone #	CellularPhone	Phone	40	No	None
Fax Phone #	FaxPhone	Phone	40	No	None
First Name	FirstName	Text	50	Yes	None
Home Phone #	HomePhone	Text	40	No	None
Job Title	JobTitle	Text	75	No	None
Last Name	LastName	Text	50	Yes	None
M/M	MM	Text	15	No	None
Middle Name	MiddleName	Text	50	No	None
operation	operation	Text	30	No	None
Party UId	PartyUId	Text	100	Yes	None
Person UId	PersonUId	Id	30	No	None
Preferred Communication Method	PreferredCommunicationMethod	Text	20	No	Bound by COMM_METHOD
Privacy Code	PrivacyCode	Text	30	Yes	Bound by PRIVACY_CODE
Row Id	RowId	Id	100	No	None
searchspec	searchspec	Text	250	No	None
Work Phone #	WorkPhone	Phone	45	No	None
IC: Contact_Personal Address					None
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
operation	operation	Text	30	No	None
Personal Address Id	PersonalAddressId	Id	100	Yes	None
Personal Address Integration Id	PersonalAddressIntegrationId	Text	30	No	None
Personal City	PersonalCity	Text	50	Yes	None
Personal Country	PersonalCountry	Text	50	No	Bound by COUNTRY
Personal Postal Code	PersonalPostalCode	Text	30	No	None
Personal State	PersonalState	Text	10	No	Bound by STATE_ABBREV
Personal Street Address	PersonalStreetAddress	Text	200	Yes	None
searchspec	searchspec	Text	250	No	None
IC: Related Industry
Industry	Industry	Text	50	Yes	None
Industry Id	IndustryId	Id	30	Yes	None
Industry Integration Id	IndustryIntegrationId	Text	30	No	None
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
SIC Code	SICCode	Text	30	Yes	None
IC: Related Organization
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
Organization	Organization	Text	100	Yes	None
Organization Id	OrganizationId	Id	100	Yes	None
Organization Integration Id	OrganizationIntegrationId	Text	30	No	None
IC: Related Sales Reps
Division	Division	Text	255	Yes	Use to select a related entity
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
Login	Login	Id	15	No	None
Position	Position	Text	50	No	None
Position Id	PositionId	Id	30	No	None
Position Integration Id	PositionIntegrationId	Text	30	No	None
IC: Sub Account
Account Status	AccountStatus2	Text	30	No	Bound by ACCOUNT_STATUS
Id	Id	Id	100	Yes	None
Location	Location	Text	50	No	None
Main Phone Number	MainPhoneNumber	Phone	40	No	None
Name	Name	Text	100	Yes	None
operation	operation	Text	30	No	None
operation	operation	Text	30	No	None
Party UId	PartyUId	Text	30	Yes	None
Party UId	PartyUId	Text	30	No	None
searchspec	searchspec	Text	250	No	None
searchspec	searchspec	Text	250	No	None
Type	Type	Text	255	Yes	Bound by ACCOUNT_TYPE
Type	Type	Text	255	No	None
IC: Sub Account_Business Address
Address Id	AddressId	Id	30	Yes	None
Address Name	AddressName	Text	100	No	None
Integration Id	IntegrationId	Text	30	No	None
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
operation	operation	Text	30	No	None
searchspec	searchspec	Text	250	No	None
Street Address	StreetAddress	Text	200	Yes	None
IC: Sub Account_Position
Division	Division	Text	255	Yes	Use it to select a related entity
Division Integration Id	DivisionIntegrationId	Text	30	No	None
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
operation	operation	Text	30	No	None
Position	Position	Text	50	No	Bound by POSITION_TYPE
Position Id	PositionId	Id	30	No	None
searchspec	searchspec	Text	250	No	None

Account

Account messages are used in insert, query, update, and delete operations to maintain Account Profile Information. LookUpAccount Profile and LookUptProfileByName are used for query operations. UpdateAccountProfile, InsertAccountProfile, and DeleteAccountProfile are message pairs for request and response operations. The following figure describes the structure of this message.

The following table lists the Account Query Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccount	Account	LookUpAccount	UK1:PartyUId UK2: Id
CIFAccountRs	Account	LookUpAccountResponse	UK1:PartyUId UK2: Id

The following table lists the Account Query by Name Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountUpdate	Account	UpdateAccount	UK1:PartyUId UK2: Id
CIFAccountUpdateRs	Account	UpdateAccountResponse	UK1:PartyUId UK2: Id

The following table lists the Account Update Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountProductDelete	Account	UpdateAccountProduct	UK1:PartyUIdUK2: Id
CIFAccountProductDeleteRs	Account	UpdateAccountProductResponse	UK1:PartyUIdUK2: Id

The following table lists the Account Insert Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountInsert	Account	InsertAccount	UK1:PartyUId UK2: Id
CIFAccountInsertRs	Account	InsertAccountResponse	UK1:PartyUId UK2: Id

The following table lists the Account Delete Integration objects.

Integration Object	Business Component	XML Tag	User Keys
CIFAccountDelete	Account	DeleteAccount	UK1:PartyUId UK2: Id
CIFAccountDeleteRs	Account	DeleteAccountResponse	UK1:PartyUId UK2: Id

The following table lists the Account Integration Component and Integration Component Fields.

Name	XML Tag	Data Type	Length	Req	Notes
IC: Account
Account Region	AccountRegion	Text	30	No	Use for picking a related entity
Account Status	AccountStatus	Text	24	No	Bound by ACCOUNT_STATUS
Account Type Code	AccountTypeCode	Text	30	Yes	Bound by CUT_ACCOUNT_TYPE
Account Value	AccountValue	Text	30	No	Bound by FIN_CON_VALUE_TYPE
Alias	Alias	Text	50	No	None
Annual Revenue	AnnualRevenue	Text	22	No	None
Client Flag	ClientFlag	Boolean	1	No	None
Competitor	Competitor	Boolean	1	No	None
Credit Agency Number	CreditAgencyNumber	Text	30	No	None
Cumulative Sales	CumulativeSales	Number	22	No	None
Currency Code	CurrencyCode	Text	15	Yes	None
Current Volume	CurrentVolume	Currency	22	No	None
Dont Call	DontCall	Boolean	1	No	None
Drug Spent Currency Code	DrugSpentCurrencyCode	Text	30	Yes	Use for picking a related entity
Employees	Employees	Number	22	No	None
Facility Flag	FacilityFlag	Boolean	1	No	None
Federal Tax Number	FederalTaxNumber	Text	15	No	None
Financing Method	FinancingMethod	Text	30	No	Bound by FINCORP_CLIENT_FINANCING
Gross Potential Value	GrossPotentialValue	Currency	22	No	None
Group Type Code	GroupTypeCode	Text	30	Yes	Bound by GROUP_TYPE_CD
Home Page	HomePage	Text	100	No	None
Id	Id	Id	150	No	For cross-referencing
Integration Id	IntegrationId	Text	30	No	None
Internal Org Flag	InternalOrgFlag	Boolean	1	Yes	None
Investor Flag	InvestorFlag	Boolean	1	No	None
Last Year Sales	LastYearSales	Currency	22	No	None
Legal Status	LegalStatus	Text	30	No	Bound by UT_LEGAL_STATUS
Location	Location	Text	50	No	None
Main Fax Number	MainFaxNumber	Phone	40	No	None
Main Phone Number	MainPhoneNumber	Phone	40	No	None
Master Account Id	MasterAccountId	Id	15	No	None
Name	Name	Text	100	Yes	None
operation	operation	Text	30	No	None
Partner Flag	PartnerFlag	Boolean	1	No	None
Party UId	PartyUId	Text	100	Yes	None
Privacy Code	PrivacyCode	Text	30	Yes	Bound by PRIVACY_CODE
Reference Flag	ReferenceFlag	Boolean	1	No	None
Referenciable	Referenciable	Boolean	1	No	None
Revenue Growth	RevenueGrowth	Number	22	No	None
Service Provider Flag	ServiceProviderFlag	Text	1	No	None
Status	Status	Text	30	No	Bound by FINS_COMPETITOR_STATUS_MLOV
Total # Meters	TotalMeters	Number	22	No	None
Total Potential Volume	TotalPotentialVolume	Currency	22	No	None
Type	Type	Text	30	Yes	Bound by ACCOUNT_TYPE
Unionized	Unionized	Boolean	1	No	None
YTD Net Contribution	YTDNetContribution	Currency	22	No	None
IC: Account_Business Address
Address Id	AddressId	Id	30	Yes	None
Address Integration Id	AddressIntegrationId	Text	30	No	None
Bill Address Flag	BillAddressFlag	Text	1	No	None
City	City	Text	50	No	None
Country	Country	Text	50	No	Use it for picking a related entity
Email Address	EmailAddress	Text	50	No	None
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
operation	operation	Text	30	No	None
Postal Code	PostalCode	Text	30	No	None
searchspec	searchspec	Text	250	No	None
Ship Address Flag	ShipAddressFlag	Text	1	No	None
State	State	Text	10	No	Bound by STATE_ABBREV
Street Address	StreetAddress	Text	200	No	None
IC: Action
Alarm	Alarm	Boolean	1	No	None
Assignment Excluded	AssignmentExcluded	Boolean	1	No	None
Associated Cost	AssociatedCost	Currency	22	No	None
Billable Flag	BillableFlag	Boolean	1	No	None
Call Id	CallId	Text	30	No	None
Category	Category	Text	30	Yes	Use for picking a related entity
Class	Class	Text	30	No	Bound by FS_ACTIVITY_CLASS
Comment	Comment	Text	“1,500"	No	None
Description	Description	Text	100	No	None
Display	Display	Text	30	No	None
Done	Done	UTC date time	7	No	None
Done Flag	DoneFlag	Boolean	1	No	None
Due	Due	UTC date time	7	No	None
Duration Minutes	DurationMinutes	Integer	22	No	Bound by APPOINTMENT_DURATION
Expense Related Flag	ExpenseRelatedFlag	Boolean	1	No	None
Id	Id	Text	100	Yes	None
Integration Id	IntegrationId	Text	30	No	None
No Sooner Than Date	NoSoonerThanDate	UTC date time	7	No	None
Objective	Objective	Text	30	No	None
operation	operation	Text	30	No	None
Owned By	OwnedBy	Text	30	Yes	Use it for picking a related entity
Owned By Id	OwnedById	Text	30	Yes	None
Primary Owned By	PrimaryOwnedBy	Text	50	No	Use it for picking a related entity
Primary Owner Id	PrimaryOwnerId	Id	30	No	None
Priority	Priority	Text	30	No	Bound by ACTIVITY_PRIORITY
Private	Private	Boolean	1	No	None
Repeating	Repeating	Boolean	1	No	None
Repeating Expires	RepeatingExpires	Date and time	7	No	None
searchspec	searchspec	Text	250	No	None
Status	Status	Text	30	No	Bound by EVENT_STATUS
Type	Type2	Text	30	Yes	Bound by TODO_TYPE
IC: Contact
Account Id	AccountId	Id	30	No	None
Account Integration Id	AccountIntegrationId	Text	30	No	None
Assistant	Assistant	Text	50	No	None
Assistant Phone #	AssistantPhone	Phone	40	No	None
Cellular Phone #	CellularPhone	Phone	40	No	None
Fax Phone #	FaxPhone	Phone	40	No	None
First Name	FirstName	Text	50	Yes	None
Home Phone #	HomePhone	Text	40	No	None
Job Title	JobTitle	Text	75	No	None
Last Name	LastName	Text	50	Yes	None
M/M	MM	Text	15	No	None
Middle Name	MiddleName	Text	50	No	None
operation	operation	Text	30	No	None
Party UId	PartyUId	Text	100	Yes	None
Person UId	PersonUId	Id	30	Yes	None
Preferred Communication Method	PreferredCommunicationMethod	Text	20	No	Bound by COMM_METHOD
Privacy Code	PrivacyCode	Text	30	Yes	Bound by PRIVACY_CODE
Row Id	RowId	Id	100	No	None
searchspec	searchspec	Text	250	No	None
Work Phone #	WorkPhone	Phone	45	No	None
IC: FINCORP Deposit Account
Account Branch Number	AccountBranchNumber	Text	100	No	None
Account Category	AccountCategory	Text	30	No	Bound by FINS_ASSET_PROD_CLASS_MLOV
Account Number	AccountNumber	Text	100	Yes	None
Account Status	AccountStatus	Text	30	No	Bound by FINS_CRPST_LFLN_IPFS_PLC_MLOV
Branch	Branch	Text	50	No	None
Current Balance	CurrentBalance	Currency	22	No	None
Id	Id	Text	100	No	None
Integration Id	Integration Id	Text	30	No	None
Name	Name	Text	100	Yes	Use it for picking a related entity
operation	operation	Text	30	No	None
Product Id	ProductId	Id	100	Yes	None
searchspec	searchspec	Text	250	No	None
Type	Type	Text	30	No	Bound by FINS_OWNERSHIP_TYPE_MLOV
IC: FINCORP Loan Account
Account Branch Number	AccountBranchNumber	Text	30	No	None
Account Category	AccountCategory	Text	30	No	Bound by FINS_ASSET_PROD_CLASS_MLOV
Account Number	AccountNumber	Text	100	Yes	None
Account Status	AccountStatus	Text	30	No	Bound by FINS_CRPST_LFLN_IPFS_PLC_MLOV
Current Balance	CurrentBalance	Currency	22	No	None
Id	Id	Text	30	No	None
Integration Id	IntegrationId	Text	30	No	None
Name	Name	Text	100	Yes	Use it for picking a related entity
operation	operation	Text	30	No	None
Product Id	ProductId	Id	100	Yes	Use it for picking a related entity
searchspec	searchspec	Text	250	No
Type	Type	Text	30	No	FINS_OWNERSHIP_TYPE_MLOV
IC: Related Industry
Industry	Industry	Text	50	Yes	None
Industry Id	IndustryId	Id	30	Yes	None
Industry Integration Id	IndustryIntegrationId	Text	30	No	None
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
Organization	Organization	Text	100	Yes	None
Organization Id	OrganizationId	Id	100	Yes	None
Organization Integration Id	OrganizationIntegrationId	Text	30	No	None
Related Organization
SIC Code	SICCode	Text	30	Yes	None
IC: Related Sales Reps
Division	Division	Text	255	Yes	Use to select a related entity
IsPrimaryMVG	IsPrimaryMVG	Text	1	No	None
Login	Login	Id	15	No	None
Position	Position	Text	50	No	None
Position Id	PositionId	Id	30	No	None
Position Integration Id	PositionIntegrationId	Text	30	No	None
IC: Sub Account
Account Status	AccountStatus2	Text	30	No	Bound by ACCOUNT_STATUS
Id	Id	Id	100	Yes	None
Location	Location	Text	50	No	None
Main Phone Number	MainPhoneNumber	Phone	40	No	None
Name	Name	Text	100	Yes	None
operation	operation	Text	30	No	None
Party UId	PartyUId	Text	30	Yes	None
searchspec	searchspec	Text	250	No	None
Type	Type	Text	255	Yes	Bound by ACCOUNT_TYPE
IC: UCM Account Privacy
Account Id	AccountId	Id		No	None
Affiliate Flag	AffiliateFlag	Text	30	No	None
Affiliate Flag	AffiliateFlag	Text	30	No	None
Affiliate Method	AffiliateMethod	Text	30	No	None
Affiliate Method	AffiliateMethod	Text	30	No	None
Affiliate Source	AffiliateSource	Text	30	No	None
Affiliate Source	AffiliateSource	Text	30	No	None
Affiliate System	AffiliateSystem	Text	30	No	None
Affiliate System	AffiliateSystem	Text	30	No	None
Channel Flag	ChannelFlag	Text	30	No	None
Channel Flag	ChannelFlag	Text	30	No	None
Channel Method	ChannelMethod	Text	30	No	None
Channel Method	ChannelMethod	Text	30	No	None
Channel Source	ChannelSource	Text	30	No	None
Channel Source	ChannelSource	Text	30	No	None
Channel System	ChannelSystem	Text	30	No	None
Channel System	ChannelSystem	Text	30	No	None
Contact Id	ContactId	Id	30	No	None
Cover Letter Type	CoverLetterType	Text	30	No	None
Cover Letter Type	CoverLetterType	Text	30	No	None
Cover Letter Type II	CoverLetterTypeII	Text	30	No	None
Cover Letter Type II	CoverLetterTypeII	Text	30	No	None
IC: UCM Contact Privacy
Id	Id	Id	30	No	None
Id	Id	Id	30	No	None
Integration Id	IntegrationId	Text	30	No	None
Integration Id	IntegrationId	Text	30	No	None
Nonaffiliate Flag	NonaffiliateFlag	Text	30	No	None
Nonaffiliate Flag	NonaffiliateFlag	Text	30	No	None
Nonaffiliate Method	NonaffiliateMethod	Text	30	No	None
Nonaffiliate Method	NonaffiliateMethod	Text	30	No	None
Nonaffiliate Source	NonaffiliateSource	Text	30	No	None
Nonaffiliate Source	NonaffiliateSource	Text	30	No	None
Nonaffiliate System	NonaffiliateSystem	Text	30	No	None
Nonaffiliate System	NonaffiliateSystem	Text	30	No	None
Notice Send Flag	NoticeSendFlag	Text	30	No	None
Notice Send Flag	NoticeSendFlag	Text	30	No	None
Notice Sent Date	NoticeSentDate	UTC date time	30	No	None
Notice Sent Date	NoticeSentDate	UTC date time	30	No	None
Notice Sent Reason	NoticeSentReason	Text	100	No	None
Notice Sent Reason	NoticeSentReason	Text	100	No	None
Notice Sent Type	NoticeSentType	Text	30	No	None
Notice Sent Type	NoticeSentType	Text	30	No	None
OFAC Flag	OFACFlag	Boolean	Not applicable	No	None
OFAC Flag	OFACFlag	Boolean	Not applicable	No	None
PEND End Date	PENDEndDate	UTC date time	Not applicable	No	None
PEND End Date	PENDEndDate	UTC date time	Not applicable	No	None
PEND Start Date	PENDStartDate	UTC date time	Not applicable	No	None
PEND Start Date	PENDStartDate	UTC date time	Not applicable	No	None
Privacy Parent Type	PrivacyParentType	Text	30	No	Account
Privacy Parent Type	PrivacyParentType	Text	30	No	None
Privacy State Code	PrivacyStateCode	Text	30	No	None
Privacy State Code	PrivacyStateCode	Text	30	No	None
Receive Annual Notice Flag	ReceiveAnnualNoticeFlag	Text	30	No	None
Receive Annual Notice Flag	ReceiveAnnualNoticeFlag	Text	30	No	None
Receive Annual Notice Method	ReceiveAnnualNoticeMethod	Text	30	No	None
Receive Annual Notice Method	ReceiveAnnualNoticeMethod	Text	30	No	None
Receive Annual Notice Source	ReceiveAnnualNoticeSource	Text	30	No	None
Receive Annual Notice Source	ReceiveAnnualNoticeSource	Text	30	No	None
Receive Annual Notice System	ReceiveAnnualNoticeSystem	Text	30	No	None
Receive Annual Notice System	ReceiveAnnualNoticeSystem	Text	30	No	None
State PEND Period	StatePENDPeriod	Integer	30	No	None
State PEND Period	StatePENDPeriod	Integer	30	No	None
Telemarketing Flag	TelemarketingFlag	Text	30	No	None
Telemarketing Flag	TelemarketingFlag	Text	30	No	None
Telemarketing Method	TelemarketingMethod	Text	30	No	None
Telemarketing Method	TelemarketingMethod	Text	30	No	None
Telemarketing Source	TelemarketingSource	Text	30	No	None
Telemarketing Source	TelemarketingSource	Text	30	No	None
Telemarketing System	TelemarketingSystem	Text	30	No	None
Telemarketing System	TelemarketingSystem	Text	30	No	None
Updated	Updated	Date and time	30	No	None
Updated	Updated	Date and time	30	No	None
Updated By	UpdatedBy	Id	30	No	None
Updated By	UpdatedBy	Id	30	No	None

Cross-Reference

Cross-reference messages are used in query and response operations for account, contact and household cross-references. Each object has a pair of request and response messages. The following figure describes the structure of these messages.

The following table lists the Account Cross-Reference Integration Objects.

Integration Object	Business Component	XML Tag	User Keys
UCMAccountExternalID	Contact	LookUpAccountExternalID	UK1:PartyUId UK2: Id
UCMAccountExternalIDRs	Contact	LookUpAccountExternalIDResponse	UK1:PartyUId UK2: Id

The following table lists the Contact Cross-Reference Integration Objects.

Integration Object	Business Component	XML Tag	User Keys
UCMContactExternalID	Contact	LookUpContactExternalID	UK1:PartyUId UK2: Id
UCMContactExternalIDRs	Contact	LookUpContactExternalIDResponse	UK1:PartyUId UK2: Id

The following table lists the Household Cross-Reference Integration Objects.

Integration Object	Business Component	XML Tag	User Keys
UCMHouseholdExternalID	Household	LookUpHouseholdExternalID	UK1:Id UK2:IntegrationId UK3:PartyUId
UCMHouseholdExternalIDRs	Household	LookUpHouseholdExternalIDResponse	UK1:Id UK2:IntegrationId UK3:PartyUId

The following table lists the Account Cross-Reference Integration Component and Integration Component Fields.

Name	XML Tag	Data Type	Length	Req
IC: Account
Account Status	AccountStatus	Text	24	No
Account Type Code	AccountTypeCode	Text	30	No
Annual Revenue	AnnualRevenue	Text	Not applicable	No
Client Flag	ClientFlag	Text	Not applicable	No
Competitor	Competitor	Text	Not applicable	No
Conflict Id	ConflictId	Id	30	No
Created	Created	Date and time	30	No
Credit Agency Number	CreditAgencyNumber	Text	30	No
Currency Code	CurrencyCode	Text	15	No
Facility Flag	FacilityFlag	Text	Not applicable	No
Federal Tax Number	FederalTaxNumber	Text	15	No
Home Page	HomePage	Text	100	No
Id	Id	Id	30	No
Integration Id	IntegrationId	Text	30	No
Internal Org Flag	InternalOrgFlag	Text	Not applicable	No
Investor Flag	InvestorFlag	Text	Not applicable	No
Legal Status	LegalStatus	Text	30	No
Location	Location	Text	50	No
Main Fax Number	MainFaxNumber	Text	Not applicable	No
Main Phone Number	MainPhoneNumber	Text	Not applicable	No
Master Account Id	MasterAccountId	Id	Not applicable	No
Mod Id	ModId	Id	30	No
Name	Name	Text	100	No
operation	operation	Text	30	No
Partner Flag	PartnerFlag	Text	Not applicable	No
Party UId	PartyUId	Text	100	No
searchspec	searchspec	Text	250	No
Service Provider Flag	ServiceProviderFlag	Text	Not applicable	No
Status	Status	Text	30	No
Type	Type	Text	30	No
Updated	Updated	Date and time	30	No
IC: CIF Account Reference
Account Id	AccountId	Id	Not applicable	Yes
CIF System Id	CIFSystemId	Id	Not applicable	Yes
Comment	Comment	Text	250	No
Conflict Id	ConflictId	Id	30	No
Created	Created	Date and time	30	No
External Id1	ExternalId1	Text	100	No
External Id2	ExternalId2	Text	100	No
External Id3	ExternalId3	Text	100	No
Id	Id	Id	30	No
Mod Id	ModId	Id	30	No
operation	operation	Text	30	No
searchspec	searchspec	Text	250	No
System Name	SystemName	Text	100	No
System Number	SystemNumber	Text	30	No
Updated	Updated	Date and time	30	No

The following table lists the Contact Cross-Reference Integration Component and Integration Component Fields.

Name	XML Tag	Data Type	Length	Req
IC: Contact
Cellular Phone #	CellularPhone	Text	Not applicable	No
Conflict Id	ConflictId	Id	30	No
Created	Created	Date and time	30	No
Date of Birth	DateofBirth	Date and time	Not applicable	No
Email Address	EmailAddress	Text	50	No
Fax Phone #	FaxPhone	Text	Not applicable	No
First Name	FirstName	Text	50	No
Home Phone #	HomePhone	Text	Not applicable	No
Id	Id	Id	30	No
Integration Id	IntegrationId	Text	30	No
Job Title	JobTitle	Text	75	No
Last Name	LastName	Text	50	No
M/F	MF	Text	30	No
M/M	MM	Text	15	No
Marital Status	MaritalStatus	Text	30	No
Middle Name	MiddleName	Text	50	No
Mod Id	ModId	Id	30	No
Mother Maiden Name	MotherMaidenName	Text	50	No
operation	operation	Text	30	No
Party UId	PartyUId	Text	100	No
Person UId	PersonUId	Text	100	No
searchspec	searchspec	Text	250	No
Social Security Number	SocialSecurityNumber	Text	Not applicable	No
Status	Status	Text	30	No
Updated	Updated	Date and time	30	No
Work Phone #	WorkPhone	Text	Not applicable	No
Work Phone Extension	WorkPhoneExtension	Text	10	No
IC: CIF Contact Reference
CIF System Id	CIFSystemId	Id	Not applicable	Yes
Comment	Comment	Text	250	No
Conflict Id	ConflictId	Id	30	No
Contact Id	ContactId	Id	Not applicable	Yes
Created	Created	Date and time	30	No
External Id1	ExternalId1	Text	100	No
External Id2	ExternalId2	Text	100	No
External Id3	ExternalId3	Text	100	No
Id	Id	Id	30	No
Mod Id	ModId	Id	30	No
operation	operation	Text	30	No
searchspec	searchspec	Text	250	No
System Name	SystemName	Text	100	No
System Number	SystemNumber	Text	30	No
Updated	Updated	Date and time	30	No

The following table lists the Household Cross-Reference Integration Component and Integration Component Fields.

Name	XML Tag	Data Type	Length	Req
IC: Household
Category	Category	Text	30	No
Conflict Id	ConflictId	Id	30	No
Created	Created	Date and time	30	No
Currency Code	CurrencyCode	Text	20	No
Fax Number	FaxNumber	Text	Not applicable	No
Household Name	HouseholdName	Text	50	No
Household Number	HouseholdNumber	Text	100	No
Id	Id	Id	30	No
Integration Id	IntegrationId	Text	30	No
Mod Id	ModId	Id	30	No
operation	operation	Text	30	No
Party UId	PartyUId	Text	100	No
Phone Number	PhoneNumber	Text	Not applicable	No
searchspec	searchspec	Text	250	No
Status	Status	Text	30	No
Type	Type	Text	30	No
Updated	Updated	Date and time	30	No
IC: CIF Household Reference
CIF System Id	CIFSystemId	Id	Not applicable	Yes
Comment	Comment	Text	250	No
Conflict Id	ConflictId	Id	30	No
Created	Created	Date and time	30	No
External Id1	ExternalId1	Text	100	No
External Id2	ExternalId2	Text	100	No
External Id3	ExternalId3	Text	100	No
Household Id	ContactId	Id	Not applicable	Yes
Id	Id	Id	30	No
Mod Id	ModId	Id	30	No
operation	operation	Text	30	No
searchspec	searchspec	Text	250	No
System Name	SystemName	Text	100	No
System Number	SystemNumber	Text	30	No
Updated	Updated	Date and time	30	No