CustomFieldDefinitionDto

Defines a custom field that can be attached to entities such as clients.
Custom fields allow tenants to capture additional data beyond the built-in fields.

Properties

Name	Type	Description
code	string	The unique code for this custom field definition
The unique code for this custom field definition
label	string	The display label shown to users for this field
The display label shown to users for this field
entityType	enum	Client
Client
dataType	enum	Text Number Date Boolean Select MultiSelect TextArea Address Email
Text Number Date Boolean Select MultiSelect TextArea Address Email
options	array of string	The list of allowed options for Select and MultiSelect fields. Null for other data types.
The list of allowed options for Select and MultiSelect fields. Null for other data types.
clientTypes	array of enum	The types of clients this custom field is applicable to. An empty list means the field is applicable to all client types. PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader
The types of clients this custom field is applicable to. An empty list means the field is applicable to all client types. PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader
maxLength	integer	Maximum character length for Text and TextArea types. Null means no limit.
Maximum character length for Text and TextArea types. Null means no limit.
lines	integer	Number of visible text lines for TextArea type. Null defaults to 3.
Number of visible text lines for TextArea type. Null defaults to 3.
displayWidth	enum	Small Medium Large Full
Small Medium Large Full
booleanDisplayMode	enum	Toggle Checkbox YesNo
Toggle Checkbox YesNo
customFieldGroupCode	string	The code of the group this field belongs to
The code of the group this field belongs to
hasValues	boolean	Whether any entities have values stored for this field. Only populated on detail responses.
Whether any entities have values stored for this field. Only populated on detail responses.
isArchived	boolean	Whether this custom field definition has been archived
Whether this custom field definition has been archived
sortOrder	integer	The display order of this field relative to other custom fields
The display order of this field relative to other custom fields

JSON Example

{
  "code": "string",
  "label": "string",
  "entityType": "Client",
  "dataType": "Text",
  "options": [
    "string"
  ]
}

Used By Operations

Contained in Schemas

CustomFieldDefinitionDtoPagedResult