This request allows you to retrieve Custom Field information for a specific payment.
Click here to learn more about this request
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 Payments entity in this context.
This request will retrieve information about all of the custom fields associated with a specific payment. The response will include the following information:
id : this is the database ID of the custom field
entityId: in this context, this is the system ID of the payment
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 Using Custom Fields article. And for an example of tracking payments within the UI, our Payment History article is a good source of information.
Database
For information on bankruptcy and custom field database tables, see the following articles:
Database – Custom Field Entity (custom_field)
Database – Custom Field to Entity Map (custom_field__entity)