V3 Contracts

Conversation Log Contracts

The following section lists each contract used in the Conversation Log API and describes all the attributes that make up each contract. All attributes are optional unless otherwise specified.

Conversation Log Attributes

The following attributes are contained within the conversationLogContract object.

ATTRIBUTESDESCRIPTION
id
string
Unique identifier of the conversation log.
alerts
Array[LogAlertContract]
The LogAlertContract, which contains information about the alert.
commentList
Array[LogCommentContract]
The LogCommentContract, which contains information about the comments in the log.
comments
string
The comments associated with the conversation.
company
string
Name of the company.
createdDate
string
The date and time the conversation log was created.
email
string
The email address of the recipient.
inLogIndicator
boolean
Indicates whether the conversation log entry will display in both the Loan Log and the conversation log or if the entry will just display in the conversation log.
isEmailIndicator
boolean
Indicates whether the conversation took place via email.
name
string
Name of the person who was involved in the conversation.
phone
string
The phone number of the recipient.
createdBy
EntityReferenceContract
EntityReferenceContract containing information about the user who created the comment.

Log Alert Contract Attributes

The following attributes are contained within the LogAlertContract object.

ATTRIBUTESDESCRIPTION
id
string
Unique identifier of the alert.
dueDate
string
Due date of the alert.
followedUpDate
string
The time and date when the alert was followed up.
role
EntityReferenceContract
The role of the loan team member who is assigned to receive the alert.
createdBy
EntityReferenceContract
EntityReferenceContract containing information about the user who created the comment.

Log Comment Contract Attributes

The following attributes are contained within the LogCommentContract object.

ATTRIBUTESDESCRIPTION
id
string
Unique identifier of the log comment.
addedBy
EntityReferenceContract
EntityReferenceContract containing information about the user who created the comment. Retrieve only.
comments
string
The comments associated with the conversation.
addedDate
string
The date and time the conversation log was created. The format is yyyy-MM-ddTHH:mm:ssZ. Retrieve only.
forRole
EntityReferenceContract
The role of the loan team member who the comment is for.
reviewedBy
EntityReferenceContract
EntityReferenceContract containing information about the user who reviewed the comment. Retrieve only.
reviewedDate
string
Date the comment was last reviewed. Retrieve only.

Entity Reference Contract Attributes

The following attributes are contained within the EntityReferenceContract object.

ATTRIBUTESDESCRIPTION
entityId
string
Required. Unique identifier of the user, role, alert, etc.
entityName
string
Name of the entity. Retrieve only.
entityUri
string
Location of the entity in Encompass. Retrieve only.
entityType
string
Default, User, Role, Condition, Application, Attachment, Document, MilestoneSetting, ReoProperty, NonBorrowingOwner, Milestone, BorrowerContact, BusinessContact, Organization, Persona, Form, FieldDefinition, ExternalOrg, PipelineView, PersonaView, UserView, LoanTemplateSet, TemplateFolder, ClosingCostTemplate, LoanFolder, LoanDuplicationTemplate, Loan, Borrower, CoBorrower, ResourceLock, CorrespondentMaster, CorrespondentTrade, LoanTrade, MBSPool, Trade, UserGroup, DocumentTemplate, ConditionView, Company, CompanyExtension, Branch, BranchExtension, Vod, Voe, Vol, Vom, and Vor.