V3 Contracts

File and Folder Attributes

ATTRIBUTEDESCRIPTION
entityId
string
Unique identifier of the folder or file.
entityType
string
Possible values are file and folder.
entityName
string
Name of the file or folder.
entityUri
string
URL encoded value of absolute path of the file or folder.

Loan Program Templates Contract


ATTRIBUTEDESCRIPTION
name
string
Loan Program Template folder name of the “path” folder.
path
string
Folder location of the “path”.
contents
array
Contents of the Loan Program template folder in the request “path”. These contents are Loan Program Template entities. Can include both Loan Program template subfolders and Loan Program Templates.
contents.entityName
string
Loan Program Template contents entity name.
contents.entityType
string
Loan Program Template contents entity type. Indicates whether the entity is a sub-folder “TemplateFolder” of the request “path”. Or, an actual “LoanProgramTemplate.
Enums: TemplateFolder, LoanProgramTemplate
contents.entityPath
string
Location of the entity.
- If contents.entityType = “TemplateFolder”, then this is the location is an additional sub-folder location, within the request “path” location.
- If contents.entityType = “LoanProgramTemplate”, then this is the location of the actual Loan Program Template, within the request “path” folder.
contents.hasSubFolders
boolean
Only included in the response if the contents.entityType = “TemplateFolder”, this indicates whether the sub-folder has additional nested subfolders. Allowable values: true, false


Settlement Service Provider Template Contract

ATTRIBUTEDESCRIPTION
templateName
string
Template name.
description
string
Template description.
ignoreBusinessRules
boolean
True indicates the business rules are ignored.
additionalInfo
string
Optional addtional information.
contents
array[ServiceProviderContactContract]
Array of objects containing service provider contact information. For details, see Service Provider Contact Contract.

Service Provider Contact Contract

ATTRIBUTEDESCRIPTION
id
string
The unique identifier for the service provider contact.
altId
string
The alternate identifier. [CreateOnly] [ServiceToServiceOnly]
address
string
The address for the service provider contact.
city
string
The city for the service provider contact.
cost
number
The cost number for the service provider contact.
lineItemNumber
string
The line item number for the service provider contact.
postalCode
string
The postal zipcode for the service provider contact.
providerName
string
The provider name for the service provider contact.
relationship
string
The relationship for the service provider contact.
category
string
The category for the service provider contact.
serviceType
string
The service type for the service provider contact.
state
string
The State for the service provider contact.
webUrl
string
The website address for the service provider contact.
shopFor
boolean
True indicates the service provider is available in the shop for listing found in the Encompass marketplace
contactName
string
The name for the service provider contact.
email
string
The email address for the service provider contact.
fax
string
The fax number for the service provider contact.
ServiceProviderContactFees
array[ServiceProviderContactFeeContract]
Array of objects containing service provider contact fee information. For details, see Service Provider Contact Fee Contract.

Service Provider Contact Fee Contract

ATTRIBUTEDESCRIPTION
itemNumber
integer
The item number for the fee. [CompositeIDField][Range(1-10)]
amount
number
The fee amount.
description
string
The fee description.