Returns a list of all custom fields defined in the system. Has an ids query parameter to filter the response to return specific field definitions for specified loan custom fields.
Custom Field Attributes
Loan custom fields are defined in the customField object. The customField object attributes are described in the following table.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| id string | Loan custom field name. |
| description string | Description for loan custom field. |
| format string | See V3 Custom Field Formats. |
| maxLength integer | Indicates the maximum length of the value for the custom field. Example: If the format is STRING, provide the maximum number of characters allowed. |
| calculation string | This attribute is available to administrators and super administrators only. A custom calculation is an expression that returns a number or text value, which is then saved into the associated custom field. Custom calculations can contain simple arithmetic operations, mathematical operations, text-based operations, date-based operations, values from other fields in the same loan, and branching and logical operations. |
| audit object | Defines the audit data to return. If format is AUDIT, the custom field will contain last-change information for the field ID you specify. |
| audit.fieldId string | Required when format is AUDIT. Provide the field ID for which to display the audit information or data. |
| audit.data string | The type of last-change information to display. Specify one of the three options UserID UserName Timestamp |
| options array of strings | If the format is DROPDOWNLIST or DROPDOWN, provide the values that will appear in the drop-down list. |
| contractPath string | Contract path for loan custom field. Field is RetrieveOnly. |
| jsonPath string | JSON path for loan custom field. Field is RetrieveOnly. |
| isCalculatedField boolean | A value of true indicates the field has a calculation associated. |
© ICE Mortgage Technology, Inc. All rights reserved.