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 | Indicates the range and format of values the custom field can store. For example, a custom field defined as a ZIPCODE field can store up to 10 characters in the format XXXXX-XXXX. NONE is the default. Possible values are: AUDIT CHECK BOX DATE DECIMAL DECIMAL_1 DECIMAL2 DECIMAL3 DECIMAL4 DECIMAL6 DECIMAL7 DECIMAL10 DROPDOWN DROPDOWN-Editable INTEGER MONTHDAY PHONE SSN STATE STRING Y/N * ZIPCODE Note: These values are case-sensitive. |
| 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. |
| modelPath string | Model path for loan custom field. Example: Loan.CustomFields[(FieldName == 'CUST01FV')].StringValue |
| isCalculatedField boolean | A value of true indicates the field has a calculation associated. |