UpdateClientDataFieldDto
A single field within an UpdateClientData step configuration.
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. | ||
| sortOrder | integer | Display order within the step. |
Display order within the step. | ||
| instructions | string | Optional instructions or description for this field (supports template tokens). |
Optional instructions or description for this field (supports template tokens). | ||
| isRequired | boolean | Whether this field must be filled before the step can be completed. |
Whether this field must be filled before the step can be completed. | ||
| defaultValue | string | Optional default value to pre-fill the field with. |
Optional default value to pre-fill the field with. | ||
JSON Example
{
"fieldType": "ClientField",
"clientField": "Name",
"customFieldDefinitionCode": "string",
"sortOrder": 0,
"instructions": "string"
}