WorkflowStepClientDataFieldDto
A single field with its current value and rendering metadata.
Properties
| Name | Type | Description |
|---|---|---|
| fieldType | enum | ClientField CustomField DataFormSpecific |
ClientField CustomField DataFormSpecific | ||
| clientField | enum | Name Code Type Status Email Telephone InternalReference CanContactPost CanContactTelephone CanContactEmail CanContactSms PclSent Manager Partner Associate CompanyNumber CompaniesHouseAuthenticationCode VatNumber VatRegistered VatRegDate VatScheme VatReportingPeriod Utr SelfAssessmentUtr CompanyUtr NiNumber PayeRef AccountsOfficeRef TradingAs NatureOfBusiness IncorporationDate RegisteredAddress PostalAddress InvoiceAddress RegisteredAddressLine1 RegisteredAddressLine2 RegisteredAddressLine3 RegisteredAddressCity RegisteredAddressPostCode RegisteredAddressCountry PostalAddressLine1 PostalAddressLine2 PostalAddressLine3 PostalAddressCity PostalAddressPostCode PostalAddressCountry InvoiceAddressLine1 InvoiceAddressLine2 InvoiceAddressLine3 InvoiceAddressCity InvoiceAddressPostCode InvoiceAddressCountry ContactName ContactTitle ContactFirstName ContactMiddleName ContactLastName ContactEmail ContactPhone ContactMobile ContactDateOfBirth PersonalCode ContactRelationships Team Website ContactNationality ContactMaritalStatus ContactAddress VatPeriodEnd Notes ImportantNotes SicCodes DateOfTrading TradingAsSoleTrader LinkedInUrl FacebookUrl TwitterUrl InstagramUrl AuthSelfAssessment AuthCorporationTax AuthPayeForEmployers AuthIndividualPayAsYouEarn AuthVat AuthConstructionIndustryScheme AuthTaxCredits AuthHighIncomeChildBenefitCharge AuthMakingTaxDigitalIncomeTax AuthMakingTaxDigitalVat AuthTrusts AmlClientId Notes2 Notes3 Notes4 Notes5 VatFlatRateScheme AmlContactId RelatedClientName ContactIsPrimary ContactJobTitle RegisteredAddressCounty PostalAddressCounty InvoiceAddressCounty ContactPreferredName |
Name Code Type Status Email Telephone InternalReference CanContactPost CanContactTelephone CanContactEmail CanContactSms PclSent Manager Partner Associate CompanyNumber CompaniesHouseAuthenticationCode VatNumber VatRegistered VatRegDate VatScheme VatReportingPeriod Utr SelfAssessmentUtr CompanyUtr NiNumber PayeRef AccountsOfficeRef TradingAs NatureOfBusiness IncorporationDate RegisteredAddress PostalAddress InvoiceAddress RegisteredAddressLine1 RegisteredAddressLine2 RegisteredAddressLine3 RegisteredAddressCity RegisteredAddressPostCode RegisteredAddressCountry PostalAddressLine1 PostalAddressLine2 PostalAddressLine3 PostalAddressCity PostalAddressPostCode PostalAddressCountry InvoiceAddressLine1 InvoiceAddressLine2 InvoiceAddressLine3 InvoiceAddressCity InvoiceAddressPostCode InvoiceAddressCountry ContactName ContactTitle ContactFirstName ContactMiddleName ContactLastName ContactEmail ContactPhone ContactMobile ContactDateOfBirth PersonalCode ContactRelationships Team Website ContactNationality ContactMaritalStatus ContactAddress VatPeriodEnd Notes ImportantNotes SicCodes DateOfTrading TradingAsSoleTrader LinkedInUrl FacebookUrl TwitterUrl InstagramUrl AuthSelfAssessment AuthCorporationTax AuthPayeForEmployers AuthIndividualPayAsYouEarn AuthVat AuthConstructionIndustryScheme AuthTaxCredits AuthHighIncomeChildBenefitCharge AuthMakingTaxDigitalIncomeTax AuthMakingTaxDigitalVat AuthTrusts AmlClientId Notes2 Notes3 Notes4 Notes5 VatFlatRateScheme AmlContactId RelatedClientName ContactIsPrimary ContactJobTitle RegisteredAddressCounty PostalAddressCounty InvoiceAddressCounty ContactPreferredName | ||
| customFieldDefinitionCode | string | The custom field definition code when FieldType is CustomField. |
The custom field definition code when FieldType is CustomField. | ||
| label | string | Display label for the field. |
Display label for the field. | ||
| dataType | enum | Text Number Date Boolean Select MultiSelect TextArea Address Email File |
Text Number Date Boolean Select MultiSelect TextArea Address Email File | ||
| currentValue | string | The current value on the client record. |
The current value on the client record. | ||
| instructions | string | Optional instructions for this field (with tokens resolved). |
Optional instructions for this field (with tokens resolved). | ||
| isRequired | boolean | Whether this field must be filled before completing the step. |
Whether this field must be filled before completing the step. | ||
| sortOrder | integer | Display order within the step. |
Display order within the step. | ||
| displayWidth | enum | Small Medium Large Full |
Small Medium Large Full | ||
| options | string | JSON array of allowed values for Select/MultiSelect data types. |
JSON array of allowed values for Select/MultiSelect data types. | ||
| maxLength | integer | Maximum character length for Text and TextArea types. |
Maximum character length for Text and TextArea types. | ||
| validationPattern | string | Client-facing validation regex pattern. |
Client-facing validation regex pattern. | ||
| validationMessage | string | Client-facing validation error message. |
Client-facing validation error message. | ||
| booleanDisplayMode | enum | Toggle Checkbox YesNo |
Toggle Checkbox YesNo | ||
| defaultValue | string | Optional default value configured on the step template. |
Optional default value configured on the step template. | ||
JSON Example
{
"fieldType": "ClientField",
"clientField": "Name",
"customFieldDefinitionCode": "string",
"label": "string",
"dataType": "Text"
}