V3 Contracts

V3 Milestone Attributes

ATTRIBUTEDESCRIPTION
id
string
Unique identifier of the milestone.
startDate
string
Start date of the milestone. Format: date-time
[DateTime: yyyy-MM-ddTHH:mm:ssZ]
Days
integer
RetrieveOnly. Number of days to complete the milestone.
doneIndicator
boolean
Indicates whether the milestone has been completed.
Duration
integer
RetrieveOnly
loanAssociate
object
Object containing loan associate details. See V3 Loan Associate Attributes
reviewedIndicator
boolean
Indicates whether all activities or documents related to the milestone have been reviewed.
Comments
string
roleRequired
string
RetrieveOnly. Specifies whether assigning a loan team member to this milestone is required.
Name
string
RetrieveOnly. Name of the milestone set by the Encompass administrator.
milestoneSetting
integer
RetrieveOnly. [See: Entity Reference Contract

V3 Loan Associate Attributes

ATTRIBUTEDESCRIPTION
loanAssociateType
string
Required. Loan associate type can be user or group. This attribute is required when associating a user to a milestone or milestone-free role.
UserRequired. See: Entity Reference Contract
cellphone
string
Cell phone number of the loan associate. Will be pulled from user profile if not provided; can be provided as an override to the user profile information.
PhoneNumber: ###-###-#### ####
email
string
Email address of the loan associate. Will be pulled from user profile if not provided; can be provided as an override to the user profile information.
fax
string
Fax number of the loan associate. PhoneNumber: ###-###-#### ####
Will be pulled from user profile if not provided; can be provided as an override to the user profile information.
phone
string
Phone number of the loan associate.  PhoneNumber: ###-###-#### ####
Will be pulled from user profile if not provided; can be provided as an override to the user profile information.
RoleRetrieveOnly. Role name of the milestone or milestone-free role. See: Entity Reference Contract
Title
string
RetrieveOnly.
writeAccess
boolean
Write access indicator of the milestone or milestone-free role.
apiClientId
string
RetrieveOnly.

V3 Milestone Free Role Attributes

ATTRIBUTEDESCRIPTION
Id
string
Required. Unique Identifier of a milestone-free log.
LoanassociateRequired. Object containing loan associate details. See: V3 Loan Associate Attributes

V3 Entity Reference Contract Attributes

The following objects and attributes make up the EntityReferenceContract object.

ATTRIBUTEDESCRIPTION
entityId
string
Required.
entityName
string
RetrieveOnly.
entityUri
string
RetrieveOnly.
entityType
string
Possible values: "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", "Vor", "CustomPlanCode", "EMPlanCode", "StandardForm", "CustomForm", "ConditionType", "ConditionTemplate", "LoanProgramTemplate", "DisclosureTracking2015Log", “SettlementServiceProviderTemplate", "AffiliatedBusinessArrangements", "RateLock", "DesignatedRole", "ExternalOrgPricingGroups", "ExternalOrgCompanyStatus", "ExternalOrgCompanyRating", "LoanOriginatorCompensationPlan", "ExternalUser", "TemplateFile"