Skip to main content

Custom Fields

⚠️ Important: ALL fields in these tables will be deprecated on Wednesday, January 7th, 2025. These tables currently do not have aliased field names and will be replaced with properly named alternatives in a future update.

This documentation covers the four custom fields tables that provide access to custom field data from Simplicate.

Tables Covered​

  • api_relation_custom_fields
  • api_project_custom_fields
  • api_sale_custom_fields
  • api_employee_custom_fields

Description​

These tables expose custom field values configured in Simplicate for different entity types. Each table follows the same structure but links to a different parent entity. Custom fields are user-defined fields that allow storing additional information specific to your organization's needs.

Common Fields Structure​

All custom fields tables share the same field structure:

Field NameTypeDescription
key_model_idIntegerIdentifier of the parent entity (relation, project, sale, or employee) - ⚠️ Deprecated
report_column_1StringValue of the first custom field configured for reporting - ⚠️ Deprecated
report_column_2StringValue of the second custom field configured for reporting - ⚠️ Deprecated
report_column_3StringValue of the third custom field configured for reporting - ⚠️ Deprecated
report_column_4StringValue of the fourth custom field configured for reporting - ⚠️ Deprecated
report_column_5StringValue of the fifth custom field configured for reporting - ⚠️ Deprecated

Deprecated Fields​

⚠️ Deprecation Notice: ALL fields in these tables will be deprecated on Wednesday, January 7th, 2025.

These tables currently do not have aliased field names. The fields without aliases will be deprecated and replaced with properly named alternatives in a future update.

Table-Specific Information​

api_relation_custom_fields​

Links to api_relations via key_model_id = relation_id

api_project_custom_fields​

Links to api_projects via key_model_id = project_id

api_sale_custom_fields​

Links to api_sales via key_model_id = sale_id

api_employee_custom_fields​

Links to api_employees via key_model_id = employee_id

  • api_relations - For api_relation_custom_fields via key_model_id = relation_id
  • api_projects - For api_project_custom_fields via key_model_id = project_id
  • api_sales - For api_sale_custom_fields via key_model_id = sale_id
  • api_employees - For api_employee_custom_fields via key_model_id = employee_id