This request allows you to retrieve a loan's collateral Custom Field information.
Custom fields are used by lenders to track information that's important to their business practices but isn't native to LoanPro. Note the following when making this request:
The CustomFieldValues object is nested within the Collateral entity in this context.
This request will retrieve information about all of the custom fields associated with the collateral tracking on a loan. The response will include the following information:
id : this is the database ID of the custom field
entityId: in this context, this is the ID of the collateral
customFieldId: this is the system ID of the custom field
customFieldValue: this is the current value of the custom field
For an example of how custom fields work within the UI, take a look at our Custom Fields article.
Database
For information on customer and custom field database tables, see the following articles:
Database – Custom Field Entity (custom_field)
Database – Custom Field to Entity Map (custom_field__entity)
Database – Collateral Entity (collateral_entity)
Database – Collateral Field Entity (collateral_field_entity)