Custom fields
Custom fields allow you to add additional data to your Fintesk account that isn't included by default. Each deal, organization, person, and product item can contain custom fields. We have 16 different field types available, each with its own uses.
Creating a custom field
| Method | URL | Useful for |
|---|---|---|
POST | /dealFields | Adding a new deal field. |
POST | /organizationFields | Adding a new organization field |
POST | /personFields | Adding a new person field |
POST | /productFields | Adding a new product field |
Note that custom fields cannot be duplicated to multiple different Fintesk accounts. You can add the custom fields with the same name and field type to different accounts but they'll have different values for key parameters referenced in our API.
Naming a custom field
All custom fields are referenced as randomly generated 24-character hashes in the dataset, for example, 671a4610084c309cd93e5939 - it may look like our office cat walked across the laptop, but this actually is a key for a custom field in our API dataset.
These 24-character custom fields (for example, 671a4610084c309cd93e5939) are not shown in our API Reference as they differ for each Fintesk account, but they can be seen in the API requests and responses as well as used in the requests when adding new items or updating existing ones.
You can’t rename the reference of the custom field (the field API key), but you can rename the name of a custom field that’s visible to the User.
Inside Fintesk, you can find the API key of a field by going to Settings > Data fields and choosing the entity (deal/person/organization/product). When you hover over the row of a custom field, a three-dot menu appears on the right-hand side. From there, choose Copy API key.
Updating a custom field
| Method | URL | Useful for |
|---|---|---|
PUT | /dealFields/{id} | Updating a Deal field. |
PUT | /organizationFields/{id} | Updating an organization field |
PUT | /personFields/{id} | Updating a person field |
PUT | /productFields/{id} | Updating a product field |
Deleting a custom field
We don't recommend deleting a custom field, because it might permanently remove all data. In case you do delete by mistake, there's a chance that you can get it back by contacting our awesome support team.
| Method | URL | Useful for |
|---|---|---|
DELETE | /dealFields/{id} | Marking a deal field as deleted. |
DELETE | /organizationFields/{id} | Marking an organization field as deleted |
DELETE | /personFields/{id} | Marking a person field as deleted |
DELETE | /productFields/{id} | Marking a product field as deleted |
After a custom field is deleted, it will no longer appear in API responses. All POST requests mentioning a custom field will ignore it.
Types of custom fields
See below the 16 different types of custom fields available:
| Type | field_type | Description | Useful for | Additional info |
|---|---|---|---|---|
| Text | VarcharField | The text field is used to store texts up to 255 characters | Billing addresses, (short) comments, email addresses | |
| Large text | TextField | The large text field is used to store texts longer than usual | Comments, descriptions | |
| Numerical | NumberField | The numeric field is used to store data such as the amount of commission or other custom numerical data | Commission, priority level | The value should be numeric with a maximum precision (decimal places) of 16. If a number exceeds the maximum precision, it will stay without the full precision. |
| Monetary | MonetaryField | The monetary field is used to store data such as the amount of commission | Commission, amounts | The currency of the field will match the user’s default currency setting unless specified otherwise in the request. The format of the field is determined by the user’s locale. |
| Multiple options | MultipleChoiceField | The multiple options field lets you predefine a list of values to choose from. Multiple option fields can have a max of 10,000 options per field. | Industry type, competitors, region | |
| Single option | ChoiceField | The single option field lets you predefine a list of values out of which one can be selected.Single option fields can have a max of 10,000 options per field. | Lead type, category, industry | |
| User | UserField | The user field can contain one user amongst users of your Fintesk account* | Tech contacts, previous deal owners | |
| Organization | OrganizationField | The organization field can contain one organization out of all the organizations stored on your Fintesk account* | Related parties, partner organizations | |
| Person | PersonField | The person field can contain one person out of all the contacts stored on your Fintesk account* | Related parties, tech contacts | |
| Phone | PhonesField | A phone number field can contain a phone number (naturally) or a Skype Name with a click-to-call functionality | Skype names, phone numbers | No auto-formatting |
| Time | TimeField | The time field is used to store times, picked from a handy inline time picker | Delivery times, lunchtime | |
| Time range | TimeRangeField | The time range field is used to store time ranges picked from a handy inline time picker | Office hours, the best time to contact | |
| Date | DateField | Date field is used to store dates picked from a handy inline calendar | Delivery dates, deadlines | The format of the field is determined by the user’s locale |
| Date range | DateRangeField | The date range field is used to store date ranges picked from a handy inline calendar | Event dates, completion estimates |
Coming soon
| Address | AddressField | Address field is used to store addresses | Event places, office locations (when separate from business address) | The address field can hold all parts of address components – including City, tate, Zip Code, and Country – so there’s no need to create separate address fields for each address component. You can use Google Maps autocomplete textfield to enter addresses and visualize them on a map. You’ll also be able to filter items based on specific address criteria. |
| Autocomplete | VarcharField | The text field is used to store texts up to 255 characters and can autocomplete from the text previously inserted into this field | Custom options (e.g., tagging), email addresses |
* Doesn’t link the item with the user, person, or organization for statistics or any other form of ownership or relation, but can be used for filtering.
How to find out if a field is a custom field
The system_flag parameter in the response body of an entity’s fields can be used to identify if the field is a custom field:
true– a custom fieldfalse– Fintesk default field
{
"_id": "671a460f084c309cd93e58c4",
"active_flag": true,
"add_deal_modal_visible_flag": false,
"add_organization_modal_visible_flag": false,
"add_person_modal_visible_flag": false,
"add_product_modal_visible_flag": false,
"add_time": "2024-10-24 13:05:19",
"add_visible_flag": false,
"alias": "next_activity_subject",
"allow_bulk_edit_flag": false,
"allow_filtering_flag": false,
"allow_select_column_flag": false,
"complex_flag": false,
"created_by_user_id": "671a460f084c309cd93e5848",
"delete_flag": false,
"details_visible_flag": false,
"edit_flag": false,
"entity_id": "671a460f084c309cd93e584b",
"entity_key": "Deals",
"entity_referenced": null,
"field_type_class": "TextField",
"field_type_id": "671a460f084c309cd93e5855",
"flow_flag": false,
"help_text": "This field can have 255 characters at maximun",
"importable_flag": false,
"important_flag": false,
"internal_id": 91,
"key": "next_activity_subject",
"last_updated_by_user_id": "671a460f084c309cd93e5848",
"link": null,
"mandatory_flag": false,
"name": "next_activity_subject",
"options": [],
"order_nbr": 4,
"owner_id": "671a460f084c309cd93e5848",
"search_field": null,
"searchable_flag": false,
"sort_field": "next_activity_subject",
"sortable_flag": true,
"subfield_flag": false,
"subfields": [],
"system_flag": true,
"update_time": "2024-10-24 13:05:18",
"visible_in_exports_flag": false
}