5 Reference [Documentation]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
{{indexmenu_n>5}}

====== 5 Reference ======

===== 5.1 Permissions=====

The CRM module has the following permissions:

{| border="1" align="center" style="width:100%" 
|- style="background:#2E86C1;color:white"
! style="padding-left: 10px;width:150px"| Permission Name
! style="padding-left: 10px;"| Description
|- 
| style="padding-left: 10px;background:#AED6F1"| CRM_ACTIVITY_VIEW 
| style="padding-left: 10px;background:#AED6F1"|Enables the holder to view activity associated to contact/org
|- 
| style="padding-left: 10px;"| CRM_ALL  
| style="padding-left: 10px;"| Grants the holder access to perform any CRM Module functionality. 
|- 
| style="padding-left: 10px;background:#AED6F1"| CRM_DOC_REMOVE
| style="padding-left: 10px;background:#AED6F1"|Grants the holder access to remove documents attached to contacts or organizations.
|- 
| style="padding-left: 10px;"| CRM_DOC_UPLOAD
| style="padding-left: 10px;"|Grants the holder access to upload documents to a contact or organization.
|- 
| style="padding-left: 10px;background:#AED6F1"| CRM_DOC_VIEW
| style="padding-left: 10px;background:#AED6F1"|Grants the holder access to view the document list and uploaded documents.
|- 
| style="padding-left: 10px;"|CRM_RECEIVE_EMAIL
| style="padding-left: 10px;"|Enables the holder to receive emails from the CRM module.
|- 
| style="padding-left: 10px;background:#AED6F1"|CRM_RECEIVE_SMS *
| style="padding-left: 10px;background:#AED6F1"|Enables the holder to receive sms from the CRM module.
|- 
| style="padding-left: 10px;"| CRM_SEARCH_ALL
| style="padding-left: 10px;"| Grants the holder access to the search widget.
|- 
| style="padding-left: 10px;background:#AED6F1"|CRM_SEND_EMAIL
| style="padding-left: 10px;background:#AED6F1"|Enables the holder to send emails from within the CRM module.
|- 
| style="padding-left: 10px;"|CRM_SEND_SMS *
| style="padding-left: 10px;"|Enables the holder to send sms from within the CRM module.
|- 
| style="padding-left: 10px;background:#AED6F1"|CRM_TASK_CREATE
| style="padding-left: 10px;background:#AED6F1"|Enables the holder to create tasks with CRM.
|- 
| style="padding-left: 10px;"|CRM_TASK_DELETE
| style="padding-left: 10px;"|Enables the holder to delete tasks within CRM.
|- 
| style="padding-left: 10px;background:#AED6F1"|CRM_VIEW_EMAIL
| style="padding-left: 10px;background:#AED6F1"|Enables the holder to view email messages.
|- 
| style="padding-left: 10px;"|CRM_VIEW_SMS *
| style="padding-left: 10px;"|Enables the holder to view sms messages.
|- 
| style="padding-left: 10px;background:#AED6F1"|CUST_ALL
| style="padding-left: 10px;background:#AED6F1"|Grants the holder access to perform any Customer Utility functionality.
|- 
| style="padding-left: 10px;"|CUST_DELETE
| style="padding-left: 10px;"|Grants the holder access to delete a customer using the Customer Utility.
|- 
| style="padding-left: 10px;background:#AED6F1"|CUST_ORGANIZATION_DELETE
| style="padding-left: 10px;background:#AED6F1"|Grants the holder access to delete an organization in the Customer Utility.
|- 
| style="padding-left: 10px;"|CUST_ORGANIZATION_EDIT
| style="padding-left: 10px;"|Grants the holder access to edit an organization in the Customer Utility.
|- 
| style="padding-left: 10px;background:#AED6F1"|CUST_ORGANIZATION_VIEW 
| style="padding-left: 10px;background:#AED6F1"|Grants the holder access to view an organization in the Customer Utility.
|- 
| style="padding-left: 10px;"|CUST_READ 
| style="padding-left: 10px;"|Grants the holder access to read a customer using the Customer Utility.
|- 
| style="padding-left: 10px;background:#AED6F1"|CUST_TAG_ADD
| style="padding-left: 10px;background:#AED6F1"|Grants the holder access to add a tag to a customer or organization using the Customer Utility.
|- 
| style="padding-left: 10px;"|CUST_TAG_REMOVE
| style="padding-left: 10px;"|Grants the holder access to remove a tag from a customer or organization using the Customer Utility.
|- 
| style="padding-left: 10px;background:#AED6F1"|CUST_WRITE 
| style="padding-left: 10px;background:#AED6F1"|Grants the holder access to write a customer using the Customer Utility.
|}

* Currently, SMS capabilities are not supported in the Thinx! CRM module.  These capabilities are planned for a future release.


{| border="1" align="center" style="width:100%"
|- style="background:#222626;color:white"
! style="padding-left: 10px;width:150px"| Note
|-
| style="padding-left: 10px;background:#c9c9c9"|The CRM module leverages the Thinx customer entity utility and therefore incorporates the customer permissions within its own boundaries.  A contact within the CRM module is technically stored a Thinx customer entity; hence the interchangeability of the term contact and customer.
|}

===== 5.2 Module Return Codes =====

== Success Codes ==
CUST1000 <tab>  The operation completed successfully!\\ <tab><tab><tab><tab><tab>//This message occurs after any successful operation on a contact, such as saving the contact or adding a comment//\\ <tab><tab><tab><tab><tab>// or as otherwise noted below.//\\  

CUST2000<tab>	The operation completed successfully!\\ <tab><tab><tab><tab><tab>//This message occurs after any successful operation on an organization, such as saving an organization or adding//\\ <tab><tab><tab><tab><tab>// a comment or as otherwise noted below.//\\

CUST3000<tab>	The operation completed successfully!\\ <tab><tab><tab><tab><tab>//This message occurs after successfully adding a tag to a contact or organization.//\\

== Warning Codes ==

CUST1107<tab>	Bulk Customer operation contained failures. Please see the logs for details.\\
CUST1108<tab>	Error converting search criteria into query fields\\
CUST2107<tab>	Bulk Organization operation contained failures.  Please see the logs for details.\\

== Error Codes ==
CRM1100<tab>	Generic CRM Error..\\
CRM1101<tab>	Required parameters cannot be null.\\
CRM1102<tab>	An error occurred while finding the organization.\\
CRM1105<tab>	Failed to delete.\\
CRM1106<tab>	Unsupported file attachment type.\\
CRM1107<tab>	Virus infected file attachment.\\
CRM1108<tab>	An error occurred while saving attachment.\\
CRM1109<tab>	Missing file attachment.\\
CRM1110<tab>	An error occurred while getting summary.\\
CRM1111<tab>	Error while removing attachment.\\
CRM1112<tab>	Failed to get Widget occasions.\\
CRM1113<tab>	Failed to get customer MetricWidget.\\
CRM1114<tab>	Document removed successfully.\\
CRM1115<tab>	Failed to get audit actions.\\
CRM1118<tab>	Failed to update the document.\\
CRM1119<tab>	Failed to send message.\\
CRM1120<tab>	Failed to receive message.\\
CRM1121<tab>	An error occurred while running your query.\\
CRM1122<tab>	Failed to get case instances.\\
CRM9999<tab>	General CRM Exception.\\
CUST1100<tab>	An error occurred during processing.\\
CUST1101<tab>	Required parameters cannot be null.\\
CUST1102<tab>	Cannot find the customer in order to perform the operation(s).\\
CUST1103<tab>	Permission denied to customer object.\\
CUST1104<tab>	Cannot add, update, remove key customers in organization.\\
CUST1105<tab>	Object extensions failed validation or type process.\\
CUST1106<tab>	Must remove organization as key organization before removing from contact.\\
CUST2100<tab>	An error occurred during processing.\\
CUST2101<tab>	Required parameters cannot be null.\\
CUST2102<tab>	Cannot find the organization in order to perform the operation(s).\\
CUST2103<tab>	Permission denied to organization object.\\
CUST2106<tab>	Must remove contact as key contact before removing from organization.\\
CUST3100<tab>	An error occurred during the tag processing.\\
CUST3101<tab>	Required parameters cannot be null.\\
CUST3102<tab>	Cannot find the object to assign or unassign tag(s).\\
CUST3103<tab>	Permission denied to object to assign or unassign tag(s).\\
CUST3104<tab>	Unknown Object Type. Use ObjectType.CUSTOMER or ObjectType.ORGANIZATION.\\
CUST4100<tab>	An error occurred during the comment processing.\\
CUST4101<tab>	Required parameters cannot be null.\\
CUST4102<tab>	Cannot find the object to add, update, or remove comment.\\
CUST4103<tab>	Permission denied to object to add, update, or remove comment.\\
CUST4104<tab>	Unknown Object Type. Use ObjectType.CUSTOMER or ObjectType.ORGANIZATION.\\
CUST4105<tab>	Invalid comment index.\\
CUST4106<tab>	Cannot find comment to update.\\
CUST5114<tab>	Required parameters cannot be null when providing voice in object contact field.\\
CUST5115<tab>	Unable to parse phone number using country code and value.\\
CUST5116<tab>	Failed validating phone number using country code and value.\\
CUST9999<tab>	General customer Failure.\\


{| border="1" align="center" style="width:100%"
|- style="background:#222626;color:white"
! style="padding-left: 10px;width:150px"| Note
|-
| style="padding-left: 10px;background:#c9c9c9"|The CRM module leverages the Thinx customer entity utility and therefore incorporates the customer error codes and messages within its own boundaries.  A contact within the CRM module is technically stored a Thinx customer entity; hence the interchangeability of the term contact and customer.
|}


===== 5.3	Structured Attributes =====
This section describes the structured attributes available for every contact and organization entity.  Contacts within the Thinx! CRM module are represented by the Thinx! customer utility.  Therefore, this section technically describes the Thinx! customer entity’s structured data.

The sub-entities are also described in this section.
{| border="1" align="center" style="width:100%" 
|- style="background:#076471;color:white"
! style="padding-left: 10px;width:150px"| Attribute
! style="padding-left: 10px;width:100px"| Type
! style="padding-left: 10px;width:100px"| Description
|- 
| style="padding-left: 10px;background:#c9c9c9"| **Customer Entity**
| style="padding-left: 10px;background:#c9c9c9"|
| style="padding-left: 10px;background:#c9c9c9"|
|- 
| style="padding-left: 10px;"|addresses 
| style="padding-left: 10px;"|List
| style="padding-left: 10px;"|The addresses associated with the contact.  The list consists of <color #00a2e8>__Address__</color> entities.
|- 
| style="padding-left: 10px;"|clientId 
| style="padding-left: 10px;"|Integer
| style="padding-left: 10px;"|The unique number assigned to your Thinx! Platform account.  This number is automatically populated and cannot be overridden.
|- 
| style="padding-left: 10px;"|comments
| style="padding-left: 10px;"|List
| style="padding-left: 10px;"|Contains any comments associated to the Contact.  The list consists of <color #00a2e8>__Comment__</color> entities.
|- 
| style="padding-left: 10px;"|contact
| style="padding-left: 10px;"|<color #00a2e8>__ContactCommunication__</color>
| style="padding-left: 10px;"|The information of the person serving as a point of contact for the Contact itself.  This could be the administrative professional assisting the Contact.
|- 
| style="padding-left: 10px;"|createdBy
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The userid of the user which created the Contact.
|- 
| style="padding-left: 10px;"|createdDateLong
| style="padding-left: 10px;"|Long
| style="padding-left: 10px;"|The timestamp of the Contact’s creation date in terms of milliseconds since 1/1/1970.  This timestamp can be used to retrieve a Javascript and Java date object.
|- 
| style="padding-left: 10px;"|customers
| style="padding-left: 10px;"|Customer
| style="padding-left: 10px;"|The list of Contacts associated to this contact.  This attribute contains the Contact’s hierarchal connections.  Typically, only the summary information (such as firstName, lastName and id) is stored for connections.
|- 
| style="padding-left: 10px;"|dateCreated
| style="padding-left: 10px;"|Date
| style="padding-left: 10px;"|The timestamp of the Contact’s creation date.
|- 
| style="padding-left: 10px;"|dateModified
| style="padding-left: 10px;"|Date
| style="padding-left: 10px;"|The timestamp of the last time that the Contact was modified.
|- 
| style="padding-left: 10px;"|documents
| style="padding-left: 10px;"|List
| style="padding-left: 10px;"|Contains metadata for the documents attached to the Contact.  The list consists of  <color #00a2e8>__DocumentSummary__</color> entities.
|- 
| style="padding-left: 10px;"|firstName
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The first name of the Contact.
|- 
| style="padding-left: 10px;"|gender
| style="padding-left: 10px;"|Enumeration
| style="padding-left: 10px;"|The gender of the Contact.  The available genders are Male, Female and non-binary.
|- 
| style="padding-left: 10px;"|id
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The unique GUID of the Contact.  When creating the Contact, this value can be left blank and will automatically get generated by the CRM module.
|- 
| style="padding-left: 10px;"|inactive
| style="padding-left: 10px;"|Boolean
| style="padding-left: 10px;"|Indicates whether or not the Contact is inactive.  If a contact is not active, then the inactive attribute will be true.
|- 
| style="padding-left: 10px;"|keyCustomers
| style="padding-left: 10px;"|List
| style="padding-left: 10px;"|The list of Contacts associated to the current Contact which have Key Relationship Connection to it.  The list consists of Customer entities and typically, only the summary information (such as firstName, lastName and id) is stored for connections.
|- 
| style="padding-left: 10px;"|keyOrganizations
| style="padding-left: 10px;"|List
| style="padding-left: 10px;"|The list of Organizations associated to the current Contact which have Key Relationship Connection to it.  The list consists of Organization entities and typically, only the summary information is stored for connections).
|- 
| style="padding-left: 10px;"|languageSpoken
| style="padding-left: 10px;"|List
| style="padding-left: 10px;"|The list of languages spoken by the Contact.  The list consists of freeform String types.  
|- 
| style="padding-left: 10px;"|lastName
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The last name of the Contact
|- 
| style="padding-left: 10px;"|middleName
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The middle name of the Contact
|- 
| style="padding-left: 10px;"|modifiedBy
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The userid of the user which last modified the Contact.
|- 
| style="padding-left: 10px;"|occasions
| style="padding-left: 10px;"|List
| style="padding-left: 10px;"|The list of important occasions associated with the Contact.  The list consists of  <color #00a2e8>__Occasion__</color> entities.
|- 
| style="padding-left: 10px;"|optOut
| style="padding-left: 10px;"|Boolean
| style="padding-left: 10px;"|Indicates whether or not the Contact has opted out of any communication from your organization.   If they’ve opted out, the value of optOut is true.
|- 
| style="padding-left: 10px;"|organizations
| style="padding-left: 10px;"|List
| style="padding-left: 10px;"|The list of organizations to which this Contact is associated.  This attribute contains the Contact’s affiliation connections.  Typically, only the summary information is stored for the affiliation.  The list consists of Organization entities.
|- 
| style="padding-left: 10px;"|permission
| style="padding-left: 10px;"|List
| style="padding-left: 10px;"|The list of permissions associated to the permission.  The list consists of <color #00a2e8>__ContactPermission__</color> entities.  If permission list is empty, then all users have access to the Contact.
|- 
| style="padding-left: 10px;"|positionTitle
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The title of the Contact
|- 
| style="padding-left: 10px;"|preferredName
| style="padding-left: 10px;"|preferredName	String
| style="padding-left: 10px;"|The preferred name of the Contact
|- 
| style="padding-left: 10px;"|suffix
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|String
|- 
| style="padding-left: 10px;"|tags
| style="padding-left: 10px;"|List
| style="padding-left: 10px;"|The list of user tags associated to the Contact.  The list consists of <color #00a2e8>__Tag__</color> entities.
|-
|- 
| style="padding-left: 10px;background:#c9c9c9"| **Organization Entity**
| style="padding-left: 10px;background:#c9c9c9"|
| style="padding-left: 10px;background:#c9c9c9"| 
|-
| style="padding-left: 10px;"|addresses
| style="padding-left: 10px;"|List
| style="padding-left: 10px;"|The addresses associated with the organization.  The list consists of <color #00a2e8>__Address__</color> entities.
|- 
| style="padding-left: 10px;"|alias
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|An alias used for the Organization
|- 
| style="padding-left: 10px;"|clientId
| style="padding-left: 10px;"|Integer
| style="padding-left: 10px;"|The unique number assigned to your Thinx! Platform account.  This number is automatically populated and cannot be overridden.
|- 
| style="padding-left: 10px;"|comments
| style="padding-left: 10px;"|List
| style="padding-left: 10px;"|Contains any comments associated to the Organization.  The list consists of <color #00a2e8>__Comment__</color> entities.
|- 
| style="padding-left: 10px;"|contact
| style="padding-left: 10px;"|<color #00a2e8>__ContactCommunication__</color>
| style="padding-left: 10px;"|The information of the person serving as a point of contact for the Organization itself.
|- 
| style="padding-left: 10px;"|createdBy
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The userid of the user which created the Organization.
|- 
| style="padding-left: 10px;"|createdDateLong
| style="padding-left: 10px;"|Long
| style="padding-left: 10px;"|The timestamp of the Organization’s creation date in terms of milliseconds since 1/1/1970.  This timestamp can be used to retrieve a Javascript and Java date object.
|- 
| style="padding-left: 10px;"|customers
| style="padding-left: 10px;"|Customer
| style="padding-left: 10px;"|The list of Contacts associated to this Organization.  This attribute contains the Organization’s affiliation connections.  Typically, only the summary information is stored for connections.
|- 
| style="padding-left: 10px;"|dateCreated
| style="padding-left: 10px;"|Date
| style="padding-left: 10px;"|The timestamp of the Organization’s creation date.
|- 
| style="padding-left: 10px;"|dateModified
| style="padding-left: 10px;"|Date
| style="padding-left: 10px;"|The timestamp of the last time that the Organization was modified.
|- 
| style="padding-left: 10px;"|documents
| style="padding-left: 10px;"|List
| style="padding-left: 10px;"|Contains metadata for the documents attached to the Organization.  The list consists of <color #00a2e8>__DocumentSummary__</color> entities
|- 
| style="padding-left: 10px;"|id
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The unique GUID of the Organization.  When creating the Organization, this value can be left blank and will automatically get generated by the CRM module.
|- 
| style="padding-left: 10px;"|inactive
| style="padding-left: 10px;"|Boolean
| style="padding-left: 10px;"|Indicates whether or not the Organization is inactive.  If an Organization is not active, then the inactive attribute will be true.
|- 
| style="padding-left: 10px;"|keyCustomers
| style="padding-left: 10px;"|List
| style="padding-left: 10px;"|The list of Contacts associated to the current Contact which have Key Relationship Connection to it.  The list consists of Customer entities and typically, only the summary information (such as firstName, lastName and id) is stored for connections.
|- 
| style="padding-left: 10px;"|keyOrganizations
| style="padding-left: 10px;"|List
| style="padding-left: 10px;"|The list of Organizations associated to the current Contact which have Key Relationship Connection to it.  The list consists of Organization entities and typically, only the summary information is stored for connections).
|- 
| style="padding-left: 10px;"|modifiedBy
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The userid of the user which last modified the Organization.
|- 
| style="padding-left: 10px;"|occasions
| style="padding-left: 10px;"|List
| style="padding-left: 10px;"|The list of important occasions associated with the Organization.  The list consists of <color #00a2e8>__Occasion__</color> entities.
|- 
| style="padding-left: 10px;"|owner
| style="padding-left: 10px;"|List
| style="padding-left: 10px;"|The list of user tags associated to the Contact.  The list consists of Tag entities.
|- 
| style="padding-left: 10px;"|tags
| style="padding-left: 10px;"|List
| style="padding-left: 10px;"|The list of user tags associated to the Contact.  The list consists of <color #00a2e8>__Tag__</color> entities.
|- 
| style="padding-left: 10px;"|
| style="padding-left: 10px;"|
| style="padding-left: 10px;"|
|- 
| style="padding-left: 10px;"|
| style="padding-left: 10px;"|
| style="padding-left: 10px;"|
|- 
| style="padding-left: 10px;background:#c9c9c9"|**Address Entity**
| style="padding-left: 10px;background:#c9c9c9"|
| style="padding-left: 10px;background:#c9c9c9"|
|- 
| style="padding-left: 10px;"|line1
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|Line 1 of the address
|- 
| style="padding-left: 10px;"|line2
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|Line 2 of the address
|- 
| style="padding-left: 10px;"|line3
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|Line 3 of the address
|- 
| style="padding-left: 10px;"|line4
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|Line 4 of the address
|- 
| style="padding-left: 10px;"|state
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The state or province of the address
|- 
| style="padding-left: 10px;"|zip
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The zip code or postal code of the address
|- 
| style="padding-left: 10px;"|country
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The country of the address.
|- 
| style="padding-left: 10px;"|type
| style="padding-left: 10px;"|Enumeration
| style="padding-left: 10px;"|Describes the type of address.  Possible values are Home, Office, Business, Shipping, PO Box, Permanent, Temporary, Residentials.
|- 
| style="padding-left: 10px;background:#c9c9c9"| **Comment Entity**
| style="padding-left: 10px;background:#c9c9c9"|
| style="padding-left: 10px;background:#c9c9c9"| 
|- 
| style="padding-left: 10px;"|author
| style="padding-left: 10px;"|Person
| style="padding-left: 10px;"|The metadata entity for the comment author
|- 
| style="padding-left: 10px;"|comment
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The content body of the Contact comment 
|- 
| style="padding-left: 10px;background:#c9c9c9"|**Communication Entity**
| style="padding-left: 10px;background:#c9c9c9"|
| style="padding-left: 10px;background:#c9c9c9"|
|- 
| style="padding-left: 10px;"|mode
| style="padding-left: 10px;"|Enumeration
| style="padding-left: 10px;"|The mode of communication. Possible values are Email, Fax, Phone, or Mobile.
|- 
| style="padding-left: 10px;"|type
| style="padding-left: 10px;"|CommunicationType
| style="padding-left: 10px;"|The type of communication.  This is a free form entity.  User specify a more detailed description.  For example, if. The mode is Email, the type could me “Main Email” or “Work Email” or even “Use this”
|- 
| style="padding-left: 10px;"|primary
| style="padding-left: 10px;"|Boolean
| style="padding-left: 10px;"|Indicates whether or not this communication serves as a primary form of communication.
|- 
| style="padding-left: 10px;background:#c9c9c9"|**ContactCommunication Entity**
| style="padding-left: 10px;background:#c9c9c9"|
| style="padding-left: 10px;background:#c9c9c9"|
|- 
| style="padding-left: 10px;"|email 
| style="padding-left: 10px;"|List
| style="padding-left: 10px;"|Contains a list of valid email addresses.  The list consists of <color #00a2e8>__Email__</color> entities.
|- 
| style="padding-left: 10px;"|phone
| style="padding-left: 10px;"|List
| style="padding-left: 10px;"|Contains a list of valid phone numbers.  The list consists of <color #00a2e8>__Voice__</color> entities.
|- 
| style="padding-left: 10px;"|mobile
| style="padding-left: 10px;"|List
| style="padding-left: 10px;"|Contains a list of valid mobile phone numbers.   The list consists of <color #00a2e8>__Voice__</color> entities.
|- 
| style="padding-left: 10px;"|fax
| style="padding-left: 10px;"|List
| style="padding-left: 10px;"|Contains a list of valid fax numbers.  The list consists of <color #00a2e8>__Voice__</color> entities.
|- 
| style="padding-left: 10px;"|url
| style="padding-left: 10px;"|List
| style="padding-left: 10px;"|Contains a list of valid web urls.  The list consists of <color #00a2e8>__URL__</color> entities.
|- 
| style="padding-left: 10px;"|preferred
| style="padding-left: 10px;"|<color #00a2e8>__Communication__</color>
| style="padding-left: 10px;"|The preferred mode of communication for the contact.
|- 
| style="padding-left: 10px;"|assistant
| style="padding-left: 10px;"|<color #00a2e8>__Person__</color>
| style="padding-left: 10px;"|The attributes describing the person serving as the point of contact, such as an administrative assistant for the Contact.
|- 
|- 
| style="padding-left: 10px;background:#c9c9c9"| **ContactPermission Entity**
| style="padding-left: 10px;background:#c9c9c9"|
| style="padding-left: 10px;background:#c9c9c9"| 
|- 
| style="padding-left: 10px;"|ownerOnly
| style="padding-left: 10px;"|Boolean
| style="padding-left: 10px;"|Indicates that this permission should restrict the visibility of the Contact to the user who created it (i.e. the Contact.createdBy).  If this is true, the Contact is for all intents and purposes “private.”  Administrative users can still see this Contact, however.  If true, the value of permission is not used.
|- 
| style="padding-left: 10px;"|permission
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The CRM permission required to view the Contact.
|- 
| style="padding-left: 10px;background:#c9c9c9"|**DocumentSummary Entity**
| style="padding-left: 10px;background:#c9c9c9"|
| style="padding-left: 10px;background:#c9c9c9"|
|- 
| style="padding-left: 10px;"|createdBy
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The userid of the document uploader
|- 
| style="padding-left: 10px;"|dateCreated
| style="padding-left: 10px;"|Date
| style="padding-left: 10px;"|The timestamp of when the document was uploaded.
|- 
| style="padding-left: 10px;"|dateModified
| style="padding-left: 10px;"|Date
| style="padding-left: 10px;"|The timestamp of when the document was last modified.
|- 
| style="padding-left: 10px;"|description
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The user provided description of the document.
|- 
| style="padding-left: 10px;"|extension
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The file extension of the document.
|- 
| style="padding-left: 10px;"|id
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The system generated GUID of the document
|- 
| style="padding-left: 10px;"|modifiedBy
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The userid of the last user who modified the document
|- 
| style="padding-left: 10px;"|name
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The name of the document.
|- 
| style="padding-left: 10px;"|path
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The relative path on the file system where the document is physically located.
|- 
| style="padding-left: 10px;background:#c9c9c9"|**Email Entity**
| style="padding-left: 10px;background:#c9c9c9"|
| style="padding-left: 10px;background:#c9c9c9"|
|- 
| style="padding-left: 10px;"|email
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The actual email address
|- 
| style="padding-left: 10px;"|mode
| style="padding-left: 10px;"|Enumeration
| style="padding-left: 10px;"|The mode of communication. Possible values are Email, Fax, Phone, or Mobile.
|-
| style="padding-left: 10px;"|type
| style="padding-left: 10px;"|CommunicationType
| style="padding-left: 10px;"|The type of communication.  This is a free form entity.  User specify a more detailed description.  For example, if. The mode is Email, the type could me “Main Email” or “Work Email” or even “Use this”
|-
| style="padding-left: 10px;"|primary
| style="padding-left: 10px;"|Boolean
| style="padding-left: 10px;"|Indicates whether or not this communication serves as a primary form of communication.
|-
| style="padding-left: 10px;background:#c9c9c9"|**Occasion Entity**
| style="padding-left: 10px;background:#c9c9c9"|
| style="padding-left: 10px;background:#c9c9c9"|
|- 
| style="padding-left: 10px;"|date
| style="padding-left: 10px;"|Date
| style="padding-left: 10px;"|The date of the occasion.  This is an absolute date.  An example could be a Contract Renewal deadline.
|- 
| style="padding-left: 10px;"|recurring
| style="padding-left: 10px;"|Boolean
| style="padding-left: 10px;"|The recurring indicator is not currently supported
|- 
| style="padding-left: 10px;"|reminder
| style="padding-left: 10px;"|Boolean
| style="padding-left: 10px;"|Indicates that the date should be highlighted as it approaches.
|- 
| style="padding-left: 10px;background:#c9c9c9"|**Person Entity**
| style="padding-left: 10px;background:#c9c9c9"|
| style="padding-left: 10px;background:#c9c9c9"|
|- 
| style="padding-left: 10px;"|addresses
| style="padding-left: 10px;"|List
| style="padding-left: 10px;"|The addresses associated with the contact.  The list consists of <color #00a2e8>__Address__</color> entities.
|- 
| style="padding-left: 10px;"|clientId
| style="padding-left: 10px;"|Integer
| style="padding-left: 10px;"|The unique number assigned to your Thinx! Platform account.  This number is automatically populated and cannot be overridden.
|- 
| style="padding-left: 10px;"|contact
| style="padding-left: 10px;"|<color #00a2e8>__ContactCommunication__</color>
| style="padding-left: 10px;"|The information of the person serving as a point of contact for the Person itself.  This could be the administrative professional assisting the Person.
|- 
| style="padding-left: 10px;"|createdBy
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The userid of the user which created the Person.
|- 
| style="padding-left: 10px;"|createdDateLong
| style="padding-left: 10px;"|Long
| style="padding-left: 10px;"|The timestamp of the Person’s creation date in terms of milliseconds since 1/1/1970.  This timestamp can be used to retrieve a Javascript and Java date object.
|- 
| style="padding-left: 10px;"|dateCreated
| style="padding-left: 10px;"|Date
| style="padding-left: 10px;"|The timestamp of the Person’s creation date.
|- 
| style="padding-left: 10px;"|dateModified
| style="padding-left: 10px;"|Date
| style="padding-left: 10px;"|The timestamp of the last time that the Person was modified.
|- 
| style="padding-left: 10px;"|firstName
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The first name of the Person.
|- 
| style="padding-left: 10px;"|gender
| style="padding-left: 10px;"|Enumeration
| style="padding-left: 10px;"|The gender of the Contact.  The available genders are Male, Female and non-binary.
|- 
| style="padding-left: 10px;"|id
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The unique GUID of the Contact.  When creating the Contact, this value can be left blank and will automatically get generated by the CRM module.
|- 
| style="padding-left: 10px;"|languageSpoken
| style="padding-left: 10px;"|List
| style="padding-left: 10px;"|The list of languages spoken by the Person.  The list consists of freeform String types.  
|- 
| style="padding-left: 10px;"|lastName
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The last name of the Person
|- 
| style="padding-left: 10px;"|middleName
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The middle name of the  Person
|- 
| style="padding-left: 10px;"|modifiedBy
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The userid of the user which last modified the  Person.
|- 
| style="padding-left: 10px;"|occasions
| style="padding-left: 10px;"|List
| style="padding-left: 10px;"|The list of important occasions associated with the Person.  The list consists of <color #00a2e8>__Occasion__</color> entities.
|- 
| style="padding-left: 10px;"|preferredName
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The preferred name of the Person
|- 
| style="padding-left: 10px;"|suffix
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The suffix of the Person
|- 
| style="padding-left: 10px;background:#c9c9c9"|**Tag Entity**
| style="padding-left: 10px;background:#c9c9c9"|
| style="padding-left: 10px;background:#c9c9c9"|
|- 
| style="padding-left: 10px;"|createdBy
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The userid of the user which created the Tag.
|- 
| style="padding-left: 10px;"|dateCreated
| style="padding-left: 10px;"|Date
| style="padding-left: 10px;"|The timestamp of the Tag’s creation date.
|- 
| style="padding-left: 10px;"|dateModified
| style="padding-left: 10px;"|Date
| style="padding-left: 10px;"|The timestamp of the last time that the Tag was modified.
|- 
| style="padding-left: 10px;"|modifiedBy
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The userid of the user which last modified the Tag.
|- 
| style="padding-left: 10px;"|value
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The actual value of the tag.
|- 
| style="padding-left: 10px;background:#c9c9c9"|**URL Entity**
| style="padding-left: 10px;background:#c9c9c9"|
| style="padding-left: 10px;background:#c9c9c9"|
|- 
| style="padding-left: 10px;"|address
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The web address of the URL; must start with http or https
|- 
| style="padding-left: 10px;"|icon
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The corresponding icon representing the web address.  This icon must be part of the font awesome icon set.
|- 
| style="padding-left: 10px;"|label
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The label of the URL for display to end users.
|- 
| style="padding-left: 10px;"|mode
| style="padding-left: 10px;"|Enumeration
| style="padding-left: 10px;"|The mode of communication. Possible values are Email, Fax, Phone, or Mobile.
|- 
| style="padding-left: 10px;"|type
| style="padding-left: 10px;"|CommunicationType
| style="padding-left: 10px;"|The type of communication.  This is a free form entity.  User specify a more detailed description.  For example, if. The mode is Email, the type could me “Main Email” or “Work Email” or even “Use this”
|- 
| style="padding-left: 10px;"|primary
| style="padding-left: 10px;"|Boolean
| style="padding-left: 10px;"|Indicates whether or not this communication serves as a primary form of communication.
|- 
| style="padding-left: 10px;background:#c9c9c9"|**Voice Entity**
| style="padding-left: 10px;background:#c9c9c9"|
| style="padding-left: 10px;background:#c9c9c9"|
|- 
| style="padding-left: 10px;"|countryCode
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The country code to which the number belongs.  Must be the official country abbreviation. EX – US for the United States and CN for China.
|- 
| style="padding-left: 10px;"|countryDailingCode
| style="padding-left: 10px;"|Integer
| style="padding-left: 10px;"|The assigned country dialing code.  This code is used during phone number validation.
|- 
| style="padding-left: 10px;"|extension
| style="padding-left: 10px;"|Integer
| style="padding-left: 10px;"|The  extension of the phone number.
|- 
| style="padding-left: 10px;"|mode
| style="padding-left: 10px;"|Enumeration
| style="padding-left: 10px;"|The mode of communication. Possible values are Email, Fax, Phone, or Mobile.
|- 
| style="padding-left: 10px;"|normalizedValue
| style="padding-left: 10px;"|String
| style="padding-left: 10px;"|The formatted phone number as specified in the value attribute.
|- 
| style="padding-left: 10px;"|primary
| style="padding-left: 10px;"|Boolean
| style="padding-left: 10px;"|Indicates whether or not this communication serves as a primary form of communication.
|- 
| style="padding-left: 10px;"|type
| style="padding-left: 10px;"|CommunicationType
| style="padding-left: 10px;"|The type of communication.  This is a free form entity.  User specify a more detailed description.  For example, if. The mode is Email, the type could me “Main Email” or “Work Email” or even “Use this”
|- 
| style="padding-left: 10px;"|value
| style="padding-left: 10px;"|Long
| style="padding-left: 10px;"|The actual phone number, numbers only.

|}

===== 5.4 API Reference=====
The Thinx! CRM module publishes a Swagger endpoint with the relevant REST APIs documented.  In order to invoke the APIs, an appropriately provisioned token is required.  The Swagger endpoint is:
[[https://crm.thinxsoftware.com/crm/swagger-ui.html#/]]