Create currency Custom Field

This request allows you to create a currency Custom Field.

   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 using this request:

Custom fields can display several different types of information. This request creates a custom field that displays a currency value.

Users create custom fields for entities such as Loans, Customers, and more. Once the field has been set up, it will be included as an option for each newly created entity. When creating the entity a custom field is associated with, the user determines the value of the custom field.

Custom fields do not update themselves automatically. However, it's possible to set a default value for the field.

For an example of how custom fields work within the UI, take a look at our Using Custom Fields article.

Database

For information on associated companies and custom field database tables, see the following articles:

Database – Custom Field Entity (custom_field)

Database – Custom Field to Entity Map (custom_field__entity)

{ "name": "Currency", "type": "customfield.type.currency", "entityType": "Entity.LoanSetup", "required": 0, "reportEnabled": 1, "creditReportEnabled": 1, "archiveEnable": 1, "autoCalculateOperationType": "customfield.autoCalculateOpType.addition", "autoCalculate": "customfield.autoCalculate.underwritingFee", "defaultValue": 95, "active": 1 }
Body Params
string
required

This is the name of the custom field.
> This field must be unique.
> Only text and numbers are valid here. Using any symbols will result in a 409 response.

string
required
Defaults to customfield.type.currency

This determines the type of the custom field. For currency custom fields, this value is set as customfield.type.currency.

string
required
Defaults to Entity.LoanSetup

This is the type of the entity that the custom field will be used for.

int32
required
Defaults to 0

This determines whether the custom field is required when creating the entity it's associated with.

int32
required
Defaults to 1

This determines whether the custom field will can be displayed as a column in either the loan or customer manager.

int32
required
Defaults to 1

This determines whether this custom field will be added to exported credit reporting data.

int32
required
Defaults to 1

This determines whether the custom field will be included in the loan status archive.

string
required
Defaults to customfield.autoCalculateOpType.addition

This determines whether to add or subtract the amount in the custom field.
> The addition or subtraction will be made on what's chosen in the autoCalculate field.

string
required
Defaults to customfield.autoCalculate.underwritingFee

This determines the calculation used for the custom field value.
> For example, listing customField.autoCalculate.underwritingFee will add or subtract the custom field value from the underwriting fee on the loan.

int32
required

This determines what the value in this custom field will default to.
> The values for this field determine whether the checkbox should be checked by default.

int32
required
Defaults to 1

This determines whether the custom field is active.

Responses

Language
Credentials