V1 Loan Pipeline

Retrieves loan IDs (GUIDs) and specified fields from loans on the Pipeline.

By default, the API filters all loans in the Pipeline to which the user has access. The results can be filtered and sorted to return more precise results. For example, to return only the loans in My Pipeline, filter by canonical name or user ID.

Usage Notes

  • A request must include either a filter or a loanGuids attribute, but not both.
  • canonicalNames in “View Pipeline” API maps to the criterionNames in “Get Canonical Names” response payload.

Filter Criteria

You can fine-tune results by defining filter criteria. The filter terms you can query against are: CanonicalName, Value, MatchType, Terms, Operator, Precision, and Include.

canonicalName

Canonical names are field definitions for all of the Encompass Pipeline fields. Every Pipeline field that can be queried has a canonical name with the format Source.Field. You can use the Source portion when there are multiple sources of data in a single query, for example, when querying recently completed loans for borrowers or business contacts.

A canonicalName attribute must be provided when using the filter parameter. The API supports the following data sources:

• Loan – The source for all fields when performing a query against the Loans database.
• Field – The source for field data stored in the Reporting Database.

Use GET loanPipeline/fieldDefinitions to return a list of accepted canonical field names.

📘

canonicalNames and criterionNames

Note that canonicalNames in “View Pipeline” API maps to the criterionNames in “Get Canonical Names” response payload.

matchType

A matchType attribute must be provided when using the filter parameter. Depending on filter criteria, options can include, greaterThanOrEquals, exact, greaterThan, isNotEmpty, isEmpty, lessThan, lessThanOrEquals, equals, notEquals, startsWith and contains.

value

Used to specify a query against any field value. Values are represented as alphanumeric values such as My Pipeline. Or numeric, such as integer, date or partial date, floating point, and currency.

Precision

Precision applies to Dates only. Possible values are:

  • exact
  • day
  • month
  • year
  • recurring

When precision = day, then loans that were last updated on the specified day are returned. It does not take into account the loans that are being updated while the request is made.

{
  "canonicalName": "Loan.LastModified",
  "value": "2015-05-23",
  "matchType": "greaterThan",
  "precision": "day"
}

include

When include = true (which is the default), results are included if the filter returns results. It applies to strings only.

When include = false, results are excluded if the filter returns results. For example, Not(Loan.LoanFolder == "My Pipeline")

{
  "canonicalName": "Loan.LoanFolder",
  "value": "My Pipeline",
  "matchType": "exact",
  "include": true
}
{
  "canonicalName": "Loan.LoanFolder",
  "value": "My Pipeline",
  "matchType": "exact",
  "include": false
}

Sort Order

Sort fields according to canonicalName and in ascending or descending order.

[
  {
    "canonicalName" : "Loan.LoanNumber",
    "order" : "asc"
  },
  {
    "canonicalName" : "Fields.4000",
    "order" : "desc"
  }
]

About Validations

  • Only canonicalName and matchType are required.
  • Either filter or loanGuids must be supplied, not both.
  • fields should be specified for the loan pipeline.

Sample Payloads

Return all data where Loan.LastModified is null. In this case, the value doesn't matter. Applies to dates only.

{
  "canonicalName": "Loan.LastModified",
  "value": "2015-05-23T21:05:46Z",
  "matchType": "isEmpty"
}

Return all data where Loan.LastModified is not null. In this case, the value also doesn't matter. Applies to dates only.

{
  "canonicalName": "Loan.LastModified",
  "value": "2015-05-23T21:05:46Z",
  "matchType": "isNotEmpty"
}
Language