CreateCustomFieldDefinitionRequest

Properties

Name	Type	Description
label	string
entityType	enum	Client
Client
dataType	enum	Text Number Date Boolean Select MultiSelect TextArea Address Email File Link
Text Number Date Boolean Select MultiSelect TextArea Address Email File Link
options	array of string
maxLength	integer
lines	integer
displayWidth	enum	Small Medium Large Full
Small Medium Large Full
booleanDisplayMode	enum	Toggle Checkbox YesNo
Toggle Checkbox YesNo
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 Association
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 Association
billableServiceCodes	array of string	The codes of the services a client must hold for this custom field to apply to them. An empty list means the field applies regardless of the client's services.
The codes of the services a client must hold for this custom field to apply to them. An empty list means the field applies regardless of the client's services.
isRequired	boolean	Whether a value must be held for this field on every client the field applies to. A required field restricted by client type or by service is required only on the clients it applies to.
Whether a value must be held for this field on every client the field applies to. A required field restricted by client type or by service is required only on the clients it applies to.
customFieldGroupCode*	string
sortOrder	integer

JSON Example

{
  "label": "string",
  "entityType": "Client",
  "dataType": "Text",
  "options": [
    "string"
  ],
  "maxLength": 0,
  "customFieldGroupCode": "string"
}

Used By Operations

POST Create CustomFieldDefinition
/tenants/{tenant}/custom-fields