V3 Manage Custom Fieldspatch https://api.elliemae.com/encompass/v3/settings/loan/customFieldsUse this API to add, update and remove custom fields. Usage Notes In order to use this API, the user must have persona access to create or update custom fields (Company settings > Loan Setup > Loan Custom Fields).Query ParamsactionstringAction to be performed. Valid values: add - To add a custom field with or without a calculation. update - To update an existing custom field.delete - To delete a custom field.viewstringOptional. View type parameter. Enumerations: entity, id When no view parameter is provided, the API will return 204 - No Content with no response body.Body ParamsidstringLoan custom field name. Max: 50 charactersdescriptionstringDescription for loan custom field. Max: 250 charactersformatstringType and format of Custom Field values. For example, a custom field defined as a ZIPCODE field can store up to 10 characters in the format XXXXX-XXXX. The default is NONE. Possible values and descriptions are listed below. Note: These values are case-sensitive. ValueDescriptionAUDITAudit - Login id, name of the user or last-change date time of the user information for the specified field Id.XCheckbox - A single character alpha field that functions as a checkbox and accepts only X.DATEDATE - A date value in the format yyyy-MM-ddDECIMALDECIMAL - A numeric field with one or more decimal digitsDECIMAL_1DECIMAL_1 - A numeric field allowing up to 1 decimal digitsDECIMAL_2DECIMAL_2 - A numeric field allowing up to 2 decimal digits.DECIMAL_3DECIMAL_3 - A numeric field allowing up to 3 decimal digits.DECIMAL_4DECIMAL_4 - A numeric field allowing up to 4 decimal digits.DECIMAL_5DECIMAL_5 - A numeric field allowing up to 5 decimal digits.DECIMAL_6DECIMAL_6 - A numeric field allowing up to 6 decimal digits.DECIMAL_7DECIMAL_7 - A numeric field allowing up to 7 decimal digits.DECIMAL_9DECIMAL_9 - A numeric field allowing up to 9 decimal digitsDECIMAL_10DECIMAL_10 - A numeric field allowing up to 10 decimal digitsDROPDOWNLISTDROPDOWNLIST - A dropdown list from which the user selects a predefined value.DROPDOWNDROPDOWN - Editable - A dropdown list that allows the user to enter text. The user can type a value or select from the list of predefined values.INTEGERINTEGER - A numeric field, with no decimal places.MONTHDAYMONTHDAY - A 5-character numeric field for recording a date in the format mm-dd.PHONEPHONE - A 17-character alpha/numeric field for recording a phone number in the format 111-111-1111 1111. Positions 4 and 8 contain dashes (-), and position 13 is a blank space.SSNSSN - An 11-character numeric field for recording a social security number. Positions 4 and 7 contain dashes.STATESTATE - A 2-character alpha field for recording a state abbreviation.STRINGSTRING - An alpha/numeric field used to type a series of characters. If the values are numbers, they cannot be used for calculations. A typical use of the String field type is for a street address.Y/NY/N - A single character alpha field that accepts only Y (for yes) or N (for no).ZIPCODEZIPCODE - A 10-character numeric field for recording zip codes in the format 11111-1111. Position 6 contains a dash (-).calculationstringThis 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.auditobjectDefines the audit data to return. If format is AUDIT, the custom field will contain last-change information for the field ID you specify.audit objectoptionsarray of stringsIf the format is DROPDOWNLIST or DROPDOWN, provide the values that will appear in the drop-down list.optionsADD stringcontractPathstringRetrieveOnly. Contract path for loan custom field.jsonPathstringRetrieveOnly. JSON path for loan custom field.isCalculatedFieldbooleanA value of true indicates the field has a calculation associated.truefalseResponses 200OK 400Bad RequestUpdated 3 months ago
© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use