Get Payment Custom Fields

General

Custom fields are used by lenders to track information that's important to their business practices but isn't native to LoanPro. Here's what you need to know about this request:

• The CustomFieldValues object is nested within the Payments entity in this context.
• This request will pull 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)
• Database – Payments (payment_entity)

📘

Try It Instructions

Our requests often provide sample payload information so that you can receive a 200 response from simply hitting the Try It button. This request is ready for you—hit Try It to send the request.

However, if you would like to try this request with your own tenant account, make sure to change the headers to match your own authentication information.