# DealFields ## Documentation The fields of a deal, the custom fields included. Each request costs 10 tokens of the daily budget of the company. - Catalog: `Pipedrive` - Schema: `Fields` - Primary Keys: `field_code` Can retrieve data and change data using insert, update and delete. ## Table Columns The columns of the table `DealFields` are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `description` | `varchar2` | | ☐ | The description of the field. | | `field_code` | `varchar2` | | ☑ | The unique identifier for the field (40-character hash for custom fields). | | `field_name` | `varchar2` | | ☐ | The display name/label of the field. | | `field_type` | `varchar2` | | ☐ | The type of the field. | | `important_fields_enabled` | `char` | | ☐ | Whether the field is marked as important. | | `important_fields_stage_ids` | `varchar2` | | ☐ | Array of stage IDs where the field is important. | | `important_fields` | `varchar2` | | ☐ | Configuration for highlighting the field at specific stages. Only taken when writing; empty when read. | | `is_custom_field` | `char` | | ☐ | Whether this is a user-created custom field. | | `is_optional_response_field` | `char` | | ☐ | Whether this field is not returned by default in entity responses. | | `options` | `varchar2` | | ☐ | Array of available options for enum/set fields, null for other field types. | | `required_fields_enabled` | `char` | | ☐ | Whether the field is required. | | `required_fields_stage_ids` | `varchar2` | | ☐ | Array of stage IDs where the field is required. | | `required_fields_statuses` | `varchar2` | | ☐ | Pipeline-specific status requirements, mapping pipeline ID to array of statuses. | | `required_fields` | `varchar2` | | ☐ | Required fields configuration for marking the field as mandatory when interacted with in the Pipedrive web UI. Only taken when writing; empty when read. | | `subfields` | `varchar2` | | ☐ | Array of subfields for complex field types (address, monetary), null for simple field types. | | `ui_visibility_add_visible_flag` | `char` | | ☐ | Whether the field is shown in the add modal. | | `ui_visibility_details_visible_flag` | `char` | | ☐ | Whether the field is shown in the details view. | | `ui_visibility_projects_detail_visible_flag` | `char` | | ☐ | Whether the field is shown in project details view. | | `ui_visibility_show_in_pipelines` | `varchar2` | | ☐ | Pipeline visibility configuration. | | `ui_visibility` | `varchar2` | | ☐ | UI visibility settings for the field. Only taken when writing; empty when read. | ## Referenced By The columns of these tables refer to a row of this table. | Table | Columns | Guarantee | |---|---|---| | [[Fields-DealFieldOptions\|Fields.DealFieldOptions]] | `field_code` | Declared by the connector, not enforced by the platform |