V1 Contracts

The following section lists each contract used in the V1 Loan Pipeline APIs and describes all the attributes that make up each contract. All attributes are optional unless otherwise specified.

V1 Loan Pipeline View Contract

The following attributes make up the V1 LoanPipelineViewContract object.

ATTRIBUTEDESCRIPTION
loanGuids
array [string]
List of loan IDs. Required if the "filter" attribute is not specified.
filter
array [string]
Criteria to filter loans as described by the V1 Query Criterion Contract.
fields
array [string]
List of fields to return.
sortOrder
array [string]
List of fields with more details like sort order as described by the V1 Loan Pipeline Sort Contract.
includeArchivedLoans
boolean
Use to indicate if the query should include archived loans.

V1 Loan Pipeline Sort Contract

The following attributes make up the V1 LoanPipelineSortContract object.

ATTRIBUTEDESCRIPTION
canonicalName
string
Canonical field name.
order
string
Possible values are None, Asc (for ascending), and Desc (for descending).

V1 Query Criterion Contract

The following attributes make up the V1 QueryCriterionContract object.

ATTRIBUTEDESCRIPTION
canonicalName
string
The canonical name of the field to be used in the query.
value
object
Using the canonicalName and the matchType operator to compare against this constant value. In all cases, this will be a single value except when utilizing the matchType of MultiValue. In the case when this is an array of values, the filter term will evaluate to true if any of the values in the array matches the value in the loan.
matchType
string
Possible values are:

- Equals
- NotEquals
- GreaterThan
- GreaterThanOrEquals
- LessThan
- LessThanOrEquals
- Exact
- StartsWith
- Contains
- IsEmpty
- IsNotEmpty
precision
string
Possible values are Exact, Minute, Hour, Day, Month, Year, and Recurring.
The default behavior is Exact.
NOTE: The Precision attribute only applies to date/dateTime values.
include
boolean
The flag include works as a NOT operator when set to false. An include value of true means all loans satisfying this query term will be considered when evaluating the loans. This is the default value. An include value of false means all loans NOT satisfying this query term will be considered when evaluating the loans. Possible values are true and false.
terms
array
For complex queries, an array of filter terms that are associated by the operator type can be provided instead of canonicalName, value, matchType and precision combination.
operator
string
The operator utilized to link multiple terms. Possible values are And and Or.