ConditionDto

A conditional-visibility rule shared by data form sections/questions and workflow
groups/steps: the item is only shown/included when the referenced field has the
ShowWhenIs value. Null (no condition object) means the item is always shown.

Properties

Name	Type	Description
sourceType	enum	FormQuestion ClientField CustomField
FormQuestion ClientField CustomField
questionCode	string	When SourceType is FormQuestion: the code of the question whose answer is compared. Only valid on data form sections/questions.
When SourceType is FormQuestion: the code of the question whose answer is compared. Only valid on data form sections/questions.
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
customFieldDefinition	CodeAndNameDto
showWhenIs	string	The value the condition source must have for the item to be visible/included. For booleans: "true" or "false". For dropdowns: the selected option value.
The value the condition source must have for the item to be visible/included. For booleans: "true" or "false". For dropdowns: the selected option value.

JSON Example

{
  "sourceType": "FormQuestion",
  "questionCode": "string",
  "clientField": "Name",
  "customFieldDefinition": {
    "code": "string",
    "name": "string"
  },
  "showWhenIs": "string"
}

Contained in Schemas

DataFormQuestionDto A question within a form section
DataFormSectionDto A section within a form
WorkflowGroupDto DTO for workflow groups within a workflow. Workflow Group Deadlines: Groups define dead...
WorkflowStepDto DTO for workflow steps within a workflow group. Used for both create/update requests and GET respons...