Database – Custom Field Entity (custom_field)
Updated 4 months ago
Description
Custom fields hold static information that needs to be updated manually. Use computation fields for information that needs automated updating. For information on using custom fields in the API, see API - Custom Fields and API - Custom Field Collections.
Column | Data Type | Column Info | Value Notes | Other |
id | int(11) | The id of the entity | ||
name | varchar(50) | Entity name | ||
description | varchar(255) | The description of the entity instance | ||
type | char(100) | Type of data stored in custom field | customfield.type.* | |
auto_calculate | char(100) | Autocalculate code for custom field | customfield.autoCalculate.* | |
auto_calculate_operation_type | char(100) | Autocalculate operation code for custom field | customfield.autoCalculateOpType.addition, customfield.autoCalculateOpType.subtraction | |
credit_report_enabled | tinyint(1) | Whether or not custom field will appear on a credit report | 1 - yes, 0 - no | |
required | tinyint(1) | Whether or not a field is requried to create an entity instance | 1 - yes, 0 - no | |
active | tinyint(1) | Whether or not the entity is active | 1 - yes, 0 - no | |
max_length | smallint(6) | The maximum length of the value | ||
searchable | tinyint(1) | Whether or not this custom field will be indexed for searching | 1 - yes, 0 - no | |
report_enabled | tinyint(1) | Whether or not this custom field can be used in a report | 1 - yes, 0 - no | |
archive_enable | tinyint(1) | Whether or not the entity is archivable | 1 - yes, 0 - no | |
summary_enabled | tinyint(1) | Whether or not the custom field is shown in the entity's summary section | 1 - yes, 0 - no | |
default_value | varchar(255) | The defualt value for the custom field | ||
entity_type | char(100) | Type of the associated entity | Entity.LoanSetup, Entity.LoanSettings, Entity.Customer, Entity.Payment, Entity.Collateral, Entity.Insurance, Entity.Bankruptcy | |
section_identifier | char(50) | Identifier for the section for the custom field | ||
display_order | int(11) | Sort order used when displaying on the UI | ||
select_options | text | Encoded options for a drop-down menu | Example: "[{\"id\":\"1\",\"label\":\"Option A\"},{\"id\":\"2\",\"label\":\"Option B\"}]" | |
deleted | tinyint(4) | Whether or not the entity was deleted | 1 - yes, 0 - no | |
lastUpdated | timestamp | Timestamp of when the entity was last updated |