# Configuration Deployments API



<EndpointIndex
  names={[
  	'downloadCurrentConfiguration',
  	'downloadConfigurationVersion',
  	'fetchConfigDefinition',
  	'fetchConfigDefinitionForAVersion',
  	'getDeployedConfigMetadata',
  	'deployConfigZip',
  	'getPartialDeployDifference',
  	'validateConfig',
  	'validateConfigZip',
  	'formatConfig',
  ]}
  titles={{
  	downloadCurrentConfiguration: 'Download the Current Configuration',
  	downloadConfigurationVersion: 'Download the Configuration for a Version',
  	fetchConfigDefinition: 'Fetch the Latest Configuration Definition',
  	fetchConfigDefinitionForAVersion:
  		'Fetch the Configuration Definition for a Version',
  	getDeployedConfigMetadata: 'Get Configuration Metadata',
  	deployConfigZip: 'Redeploy a Configuration',
  	getPartialDeployDifference: 'Get a Configuration Payload Difference',
  	validateConfig: 'Validate a Configuration Payload',
  	validateConfigZip: 'Validate a Configuration ZIP Payload',
  }}
/>

Tenant Creation [#tenant-creation]

Create a Tenant [#create-a-tenant]

<ApiEndpoint name="createTenant" title="Create a Tenant" />

<ApiSchema name="TenantDeploymentResult" />

Fetch [#fetch]

Download the Current Configuration [#download-the-current-configuration]

<ApiEndpoint name="downloadCurrentConfiguration" title="Download the Current Configuration" />

Download the Configuration for a Version [#download-the-configuration-for-a-version]

<ApiEndpoint name="downloadConfigurationVersion" title="Download the Configuration for a Version" />

Fetch the Latest Configuration Definition [#fetch-the-latest-configuration-definition]

<ApiEndpoint name="fetchConfigDefinition" title="Fetch the Latest Configuration Definition" />

Fetch the Configuration Definition for a Version [#fetch-the-configuration-definition-for-a-version]

<ApiEndpoint name="fetchConfigDefinitionForAVersion" title="Fetch the Configuration Definition for a Version" />

Get Configuration Metadata [#get-configuration-metadata]

<ApiEndpoint name="getDeployedConfigMetadata" title="Get Configuration Metadata" />

<ApiSchema name="DeployedConfigMetadata" />

Redeployment [#redeployment]

Redeploy a Configuration [#redeploy-a-configuration]

<ApiEndpoint name="deployConfigZip" title="Redeploy a Configuration" />

Get a Configuration Payload Difference [#get-a-configuration-payload-difference]

<ApiEndpoint name="getPartialDeployDifference" title="Get a Configuration Payload Difference" />

<ApiSchema name="MapDifference" />

Validation [#validation]

Validate a Configuration Payload [#validate-a-configuration-payload]

<ApiEndpoint name="validateConfig" title="Validate a Configuration Payload" />

Validate a Configuration ZIP Payload [#validate-a-configuration-zip-payload]

<ApiEndpoint name="validateConfigZip" title="Validate a Configuration ZIP Payload" />

Utility [#utility]

Format Config [#format-config]

<ApiEndpoint name="formatConfig" />

Configuration Entities [#configuration-entities]

<ApiSchema name="ConfigurationRef" />

<ApiSchema name="BootstrapRef" />

<ApiSchema name="ResourcesRef" />

<ApiSchema name="ResourceInstanceRef" />

<ApiSchema name="ResourceGroupRef" />

<ApiSchema name="JurisdictionRef" />

<ApiSchema name="ConfigBuilderResult" />

<ApiSchema name="BootstrapResult" />

<ApiSchema name="DeploymentMetadata" />

<ApiSchema name="TransactionTypeRef" />

<ApiSchema name="AccountRef" />

<ApiSchema name="ProductRef" />

<ApiSchema name="ElementRef" />

<ApiSchema name="CoverageTermRef" />

<ApiSchema name="CoverageTermOptionRef" />

<ApiSchema name="DisplayHintsRef" />

<ApiSchema name="FnolRef" />

<ApiSchema name="WorkManagementRef" />

<ApiSchema name="TaskTypeRef" />

<ApiSchema name="UserAssociationRoleRef" />

<ApiSchema name="DataTypeRef" />

<ApiSchema name="AvailabilityRef" />

<ApiSchema name="PropertyRef" />

<ApiSchema name="PropertyConstraint" />

<ApiSchema name="ConditionValueRef" />

<ApiSchema name="RestrictedDataRef" />

<ApiSchema name="Values" />

<ApiSchema name="ChargeRef" />

<ApiSchema name="BillingPlanRef" />

<ApiSchema name="DelinquencyPlanRef" />

<ApiSchema name="DelinquencyEventConfiguration" />

<ApiSchema name="InstallmentPlanRef" />

<ApiSchema name="InvoicingPlanRef" />

<ApiSchema name="AutoRenewalPlanRef" />

<ApiSchema name="RetryPlanRef" />

<ApiSchema name="PaymentRef" />

<ApiSchema name="DisbursementRef" />

<ApiSchema name="ReversalTypeRef" />

<ApiSchema name="ShortfallTolerancePlanRef" />

<ApiSchema name="ExcessCreditPlanRef" />

<ApiSchema name="NegativeInvoiceHandlingRef" />

<ApiSchema name="NumberingPlanRef" />

<ApiSchema name="ExternalNumberingPlanRef" />

<ApiSchema name="RegionRef" />

<ApiSchema name="TemplateSnippetConfigRef" />

<ApiSchema name="ScheduleRef" />

<ApiSchema name="LossRef" />

<ApiSchema name="ClaimRef" />

<ApiSchema name="TableRef" />

<ApiSchema name="RangeTableRef" />

<ApiSchema name="ColumnRef" />

<ApiSchema name="ConstraintTableRef" />

<ApiSchema name="ConstraintColumnRef" />

<ApiSchema name="DocumentConfigRef" />

The `rendering` property is set to `dynamic` for documents that are generated
with a template and `prerendered` for documents that are uploaded and used as
they are, such as for pre-rendered PDF documents.

<ApiSchema name="DocumentMarginRef" />

The `bottom`, `left`, `right` and `top` properties represent the size of the
margin in millimeters.

<ApiSchema name="ConsolidatedDocumentConfigRef" />

<ApiSchema name="ConsolidatedPageNumberingRef" />

<ApiSchema name="CustomEventRef" />

<ApiSchema name="EventScheduleRef" />

<ApiSchema name="EventCadenceRef" />

<ApiSchema name="TenantCustomEventRef" />

<ApiSchema name="TenantEventScheduleRef" />

<ApiSchema name="SecretRef" />

<ApiSchema name="PrimitivePropertyRef" />

<ApiSchema name="AuxDataSettingsRef" />

<ApiSchema name="DataAccessControlRef" />

<ApiSchema name="DataAccessControlFieldRef" />

<ApiSchema name="ContactRef" />

<ApiSchema name="AutomationPluginRef" />

<ApiSchema name="AutomationPluginActionRef" />

<ApiSchema name="ProducerManagementRef" />

<ApiSchema name="UnderwritingFlagRef" />

<ApiSchema name="ProducerCodeRef" />

<ApiSchema name="ProducerRef" />

<ApiSchema name="ProducerLicenseRef" />

<ApiSchema name="ProducerAppointmentRef" />


## API Reference

POST /config/createTenant — createTenant
Tags: root-controller
Permissions: create-tenant
Parameters:
  name (string, query)
  description (string, query)
Responses:
  200 TenantDeploymentResult — OK

GET /config/{tenantLocator}/deployments/download — downloadCurrentConfiguration
Tags: deployment-controller
Permissions: deploy
Parameters:
  tenantLocator (uuid, path, required)
Responses:
  200 — OK

GET /config/{tenantLocator}/deployments/download/{version} — downloadConfigurationVersion
Tags: deployment-controller
Permissions: deploy
Parameters:
  tenantLocator (uuid, path, required)
  version (ulid, path, required)
  byStaticLocator (boolean, query)
Responses:
  200 — OK

GET /config/{tenantLocator}/deployments/datamodel — fetchConfigDefinition
Tags: deployment-controller
Permissions: deploy, datamodel
Parameters:
  tenantLocator (uuid, path, required)
  resolve (boolean, query)
Responses:
  200 ConfigurationRef — OK

GET /config/{tenantLocator}/deployments/datamodel/{version} — fetchConfigDefinitionForAVersion
Tags: deployment-controller
Permissions: deploy, datamodel
Parameters:
  tenantLocator (uuid, path, required)
  version (ulid, path, required)
  resolve (boolean, query)
  byStaticLocator (boolean, query)
Responses:
  200 ConfigurationRef — OK

GET /config/{tenantLocator}/deployments — getDeployedConfigMetadata
Tags: deployment-controller
Permissions: read
Parameters:
  tenantLocator (uuid, path, required)
Responses:
  200 DeployedConfigMetadata — OK

POST /config/{tenantLocator}/deployments/deploy — deployConfigZip
Tags: deployment-controller
Permissions: deploy
Parameters:
  tenantLocator (uuid, path, required)
  overwrite (boolean, query)
Responses:
  200 — OK

GET /config/{tenantLocator}/deployments/diff — getPartialDeployDifference
Tags: deployment-controller
Permissions: deploy
Parameters:
  tenantLocator (uuid, path, required)
  config (ConfigurationRef, query, required)
Responses:
  200 — OK

POST /config/validateConfig — validateConfig
Tags: root-controller
Permissions: create-tenant, validate-config
Responses:
  200 — OK

POST /config/{tenantLocator}/deployments/validate — validateConfigZip
Tags: deployment-controller
Permissions: deploy
Parameters:
  tenantLocator (uuid, path, required)
Responses:
  200 — OK

POST /config/formatConfig — formatConfig
Converts a configuration's property casing to match requirements
Tags: root-controller
Permissions: create-tenant, validate-config
Responses:
  200 — OK

TenantDeploymentResult
Properties:
  locator (uuid, required)
  name (string, required)
  deploymentResult (ConfigBuilderResult, required)
  bootstrapResult (BootstrapResult, required)

DeployedConfigMetadata
Properties:
  metadata (DeploymentMetadata, required)
  pluginVersionStatus (map<string, map<string, string>>, required) [deprecated]
  pluginStatus (map<string, string>, required)
  expectedRetirementTime (datetime)

MapDifference
Properties:
  added (map<string, object>, required)
  modified (map<string, object>, required)
  removed (map<string, object>, required)

ConfigurationRef
Properties:
  defaultTimeZone (string)
  defaultCurrency (string)
  defaultTermDuration (number)
  defaultInstallmentPlan (string)
  defaultInvoicingPlan (string)
  defaultPaymentNumberingPlanName (string)
  defaultDisbursementNumberingPlanName (string)
  defaultBillingPlan (string) [deprecated]
  defaultDurationBasis (Enum years | months | weeks | days | hours)
  defaultBillingLevel (Enum account | inherit | policy) [deprecated]
  defaultBackdatedInstallmentsBilling (Enum immediate | deferDueDate)
  defaultDelinquencyPlan (string)
  defaultAutoRenewalPlan (string)
  defaultExcessCreditPlan (string)
  defaultRetryPlan (string)
  defaultLapseType (string) [deprecated]
  defaultAnchorMode (Enum generateDay | termStartDay | dueDay) [deprecated]
  defaultGenerateLeadDays (integer) [deprecated]
  defaultDueLeadDays (integer) [deprecated]
  defaultAuxDataSettings (string)
  defaultShortfallTolerancePlan (string)
  jurisdictions (map<string, JurisdictionRef>)
  regions (map<string, RegionRef>)
  defaultRegion (string) [deprecated]
  defaultSearchable (boolean)
  enableSerialInvoiceNumbering (boolean)
  enableEntityAnonymization (boolean)
  defaultScheduleUploadErrorsLimit (integer)
  dataTypes (map<string, DataTypeRef>)
  accounts (map<string, AccountRef>, required)
  policyLines (map<string, ElementRef>)
  exposureGroups (map<string, ElementRef>)
  exposures (map<string, ElementRef>)
  coverages (map<string, ElementRef>)
  products (map<string, ProductRef>, required)
  coverageTerms (map<string, CoverageTermRef>)
  charges (map<string, ChargeRef>, required)
  transactionTypes (map<string, TransactionTypeRef>)
  installmentPlans (map<string, InstallmentPlanRef>)
  invoicingPlans (map<string, InvoicingPlanRef>)
  billingPlans (map<string, BillingPlanRef>) [deprecated]
  payments (map<string, PaymentRef>)
  disbursements (map<string, DisbursementRef>)
  tables (map<string, TableRef>)
  rangeTables (map<string, RangeTableRef>)
  constraintTables (map<string, ConstraintTableRef>)
  secrets (map<string, SecretRef>)
  documents (map<string, DocumentConfigRef>)
  consolidatedDocuments (map<string, ConsolidatedDocumentConfigRef>)
  templateSnippets (map<string, TemplateSnippetConfigRef>)
  customFonts (string[])
  auxDataSettings (map<string, AuxDataSettingsRef>)
  moratoriums (map<string, MoratoriumRef>)
  customEvents (map<string, CustomEventRef>)
  delinquencyPlans (map<string, DelinquencyPlanRef>)
  shortfallTolerancePlans (map<string, ShortfallTolerancePlanRef>)
  autoRenewalPlans (map<string, AutoRenewalPlanRef>)
  excessCreditPlans (map<string, ExcessCreditPlanRef>)
  reversalTypes (map<string, ReversalTypeRef>)
  numberingPlans (map<string, NumberingPlanRef>)
  fnol (map<string, FnolRef>)
  claims (map<string, ClaimRef>)
  losses (map<string, LossRef>)
  lossCategories (string[])
  contacts (map<string, ContactRef>)
  contactRoles (string[])
  schedules (map<string, ScheduleRef>)
  workManagement (WorkManagementRef)
  dataAccessControl (DataAccessControlRef)
  bootstrap (BootstrapRef)
  defaultInvoiceDocument (string)
  retryPlans (map<string, RetryPlanRef>)
  automations (map<string, AutomationPluginRef>)
  producerManagement (ProducerManagementRef)
  externalNumberingPlans (map<string, ExternalNumberingPlanRef>)

BootstrapRef
Properties:
  resources (ResourcesRef, required)

ResourcesRef
Properties:
  resourceInstances (map<string, ResourceInstanceRef>, required)
  resourceGroups (map<string, ResourceGroupRef>, required)

ResourceInstanceRef
Properties:
  staticName (string, required)
  jurisdictions (string[], required)

ResourceGroupRef
Properties:
  selectionStartTime (datetime, required)
  resourceNames (string[], required)

JurisdictionRef
Properties:
  displayHints (DisplayHintsRef)

ConfigBuilderResult
Properties:
  isSuccess (boolean, required)
  errors (string[], required)
  metadata (DeploymentMetadata, required)

BootstrapResult
Properties:
  status (Enum queued | failed, required)
  error (string, required)

DeploymentMetadata
Properties:
  version1 (ulid, required)
  version2 (ulid, required) [deprecated]
  staticVersionLocator (ulid)
  implementedPlugins (map<string, string>, required)
  implementedAutomationPlugins (map<string, string>, required)
  latestVersion (ulid, required)

TransactionTypeRef
Properties:
  category (Enum issuance | change | renewal | cancellation | reinstatement | reversal | aggregate, required)
  costBearing (boolean, required)
  displayHints (DisplayHintsRef)

AccountRef
Properties:
  displayName (string)
  abstract (boolean)
  extend (string)
  defaultSearchable (boolean)
  data (map<string, PropertyRef>, required)
  defaultInvoiceDocument (string)
  numberingPlan (string)
  invoiceNumberingPlan (string)
  paymentExecutionRetryPlan (string)
  contacts (map<string, string[]>)
  numberingTrigger (Enum creation | validation)

ProductRef
Properties:
  extend (string)
  abstract (boolean)
  defaultInstallmentPlan (string)
  defaultBillingPlan (string) [deprecated]
  defaultTermDuration (number)
  defaultDelinquencyPlan (string)
  defaultAutoRenewalPlan (string)
  defaultShortfallTolerancePlan (string)
  displayName (string)
  defaultDurationBasis (Enum years | months | weeks | days | hours)
  coverageTerms (string[])
  eligibleAccountTypes (string[])
  eligibleTransactionTypes (string[])
  contents (string[])
  documents (string[])
  charges (string[])
  scheduledEvents (string[])
  data (map<string, PropertyRef>)
  staticData (map<string, PropertyRef>)
  defaultSearchable (boolean)
  pluralType (string) [deprecated]
  numberingPlan (string)
  numberingString (string)
  availability (AvailabilityRef)
  withPrecommitReapplication (boolean)
  requiresJurisdiction (boolean)
  contacts (map<string, string[]>)
  numberingTrigger (Enum creation | validation)
  workplanTriggers (map<string, string[]>)
  riskAssessmentCriteria (string)
  producerQualification (Enum none | license | appointment)
  externalNumberingPlan (string)
  reservedPolicyNumberRequired (boolean)

ElementRef
Properties:
  extend (string)
  abstract (boolean)
  pluralType (string) [deprecated]
  displayName (string)
  coverageTerms (string[])
  contents (string[])
  charges (string[])
  defaultSearchable (boolean)
  data (map<string, PropertyRef>)
  availability (AvailabilityRef)
  schedule (string)

CoverageTermRef
Properties:
  type (Enum splitLimit | deductible | limit, required)
  displayName (string)
  options (map<string, CoverageTermOptionRef>)
  value (PropertyRef)
  availability (AvailabilityRef)

CoverageTermOptionRef
Properties:
  displayName (string)
  value (number, required)
  tag (string)
  displayHints (DisplayHintsRef)

DisplayHintsRef
Properties:
  displayName (string)
  displayOrder (integer)

FnolRef
Properties:
  extend (string)
  abstract (boolean)
  lossTypes (string[])
  defaultSearchable (boolean)
  data (map<string, PropertyRef>, required)
  numberingPlan (string)
  contacts (map<string, string[]>)

WorkManagementRef
Properties:
  tasks (map<string, map<string, TaskTypeRef>>)
  userAssociationRoles (map<string, UserAssociationRoleRef>)
  qualifications (map<string, string[]>)

TaskTypeRef
Properties:
  defaultDeadlineDays (number, required)
  blocksUnderwriting (boolean, required)
  numberingPlan (string)
  numberingString (string)

UserAssociationRoleRef
Properties:
  appliesTo (Enum[])
  exclusive (boolean)
  qualification (map<string, string>)

DataTypeRef
Properties:
  displayName (string)
  abstract (boolean)
  extend (string)
  data (map<string, PropertyRef>, required)
  defaultSearchable (boolean)

AvailabilityRef
Specifies availability. At least one of availableAfter, retireAfter, retire, removeOnRenewalAfter, or removeOnRenewal must be set.
Properties:
  availableAfter (datetime)
  availabilityTimeBasis (Enum policyStartTime | termStartTime, required) — default: TermStartTime
  retireAfter (datetime)
  retire (boolean) — default: false
  retirementTimeBasis (Enum policyStartTime | termStartTime, required) — default: TermStartTime
  removeOnRenewalAfter (datetime)
  removeOnRenewal (boolean) — default: false

PropertyRef
Properties:
  displayName (string)
  type (string)
  scope (string)
  defaultValue (string)
  min (string)
  max (string)
  minLength (integer)
  maxLength (integer)
  precision (integer)
  options (string[])
  regex (string)
  roundingMode (Enum ceiling | down | floor | halfDown | halfEven | halfUp | up)
  tag (string[])
  constraint (PropertyConstraint)
  searchable (boolean)
  availability (AvailabilityRef)
  restrictedData (RestrictedDataRef)

PropertyConstraint
Properties:
  table (string, required)
  column (string, required)
  where (map<string, ConditionValueRef>, required)

ConditionValueRef
Properties:
  key (string, required)
  values (string[], required)

RestrictedDataRef
Properties:
  anonymizable (boolean, required)
  maskingLevel (Enum none | level1 | level2, required)
  value (Values, required)

Values
Properties:
  string (string, required)
  int (integer, required)
  long (integer, required)
  guid (string, required)
  date (date, required)
  datetime (datetime, required)
  decimal (number, required)

ChargeRef
Properties:
  displayName (string) [deprecated]
  category (Enum none | premium | tax | fee | credit | invoiceFee | cededPremium | nonFinancial | surcharge, required)
  handling (Enum flat | normal | retention, required)
  invoicing (Enum scheduled | next | immediate, required)
  transactionBundlingEnabled (boolean, required)

BillingPlanRef
Properties:
  displayName (string)
  billingLevel (Enum account | inherit | policy, required)

DelinquencyPlanRef
Properties:
  displayName (string)
  gracePeriodDays (integer, required)
  delinquencyLevel (Enum policy | invoice)
  lapseTransactionType (string)
  advanceLapseTo (Enum draft | validated | priced | underwritten | accepted | issued)
  events (map<string, DelinquencyEventConfiguration>)

DelinquencyEventConfiguration
Properties:
  offsetDays (number, required)
  offsetBasis (Enum gracePeriodStart | gracePeriodEnd, required)

InstallmentPlanRef
Properties:
  displayName (string)
  cadence (Enum none | fullPay | weekly | everyOtherWeek | monthly | quarterly | semiannually | annually | thirtyDays | everyNDays, required)
  anchorMode (Enum generateDay | termStartDay | dueDay, required)
  generateLeadDays (integer, required)
  dueLeadDays (integer, required)
  installmentWeights (number[], required)
  maxInstallmentsPerTerm (integer, required)
  autopayLeadDays (number)

InvoicingPlanRef
Properties:
  displayName (string)
  invoiceFeeHandling (Enum max | min | sum | waive, required)
  invoiceFeeAmounts (map<string, number>, required)
  consolidateInvoicesOnCancellation (Enum none | future | all, required)

AutoRenewalPlanRef
Properties:
  generateAutoRenewals (boolean, required)
  renewalTransactionType (string)
  renewalCreateLeadDays (integer)
  renewalAcceptLeadDays (integer)
  renewalIssueLeadDays (integer)
  newTermDuration (integer)

RetryPlanRef
Properties:
  attempts (integer, required)
  hoursBetweenAttempts (number[], required)

PaymentRef
Properties:
  displayName (string)
  abstract (boolean, required)
  extend (string, required)
  defaultSearchable (boolean, required)
  data (map<string, PropertyRef>)
  numberingPlan (string, required)
  numberingTrigger (Enum creation | validation, required)

DisbursementRef
Properties:
  displayName (string)
  abstract (boolean)
  extend (string)
  data (map<string, PropertyRef>, required)
  numberingPlan (string)
  numberingTrigger (Enum creation | validation)

ReversalTypeRef
Properties:
  creditType (Enum any | creditDistribution | payment, required)

ShortfallTolerancePlanRef
Properties:
  currencyTolerances (map<string, number>, required)

ExcessCreditPlanRef
Properties:
  disburseExcess (boolean, required) — Set to true to enable excess funds handling for the plan.
  disbursementType (string, required) — The type of the disbursement to be automatically created.
  excludeDebits (Enum allInvoices | invoicesAndUnbilledInstallments | none | pastDueInvoices, required) — Which pending debits should be considered for determining how much of the credit to retain
  disbursementThresholds (map<string, number>, required)
  advanceDisbursementTo (Enum draft | validated | approved | executed | reversed | rejected | discarded, required)
  autoApplyExcessToInvoicesEnabled (boolean, required)
  negativeInvoiceHandling (NegativeInvoiceHandlingRef, required)

NegativeInvoiceHandlingRef
Properties:
  automaticallySettleNegativeInvoices (Enum toOpenInvoices | toCreditBalance | never, required)
  prioritizeOverlappingCoveragePeriods (boolean, required)
  targetInvoices (Enum overlappingCoveragePeriodsOnly | overlappingCoverageAndEarlier | allOpenInvoices, required)
  targetInvoicePriority (Enum byAmount | smallestFirst | earliestFirst, required)
  processingMode (Enum accountLevel | policyLevel, required)
  yieldExcessToCreditBalance (boolean, required)

NumberingPlanRef
Properties:
  displayName (string)
  initialCoreNumber (string, required)
  format (string, required)
  copyFromQuote (boolean, required)
  termNumberFormat (string, required)
  quoteNumberFormat (string, required)
  initialQuoteCoreNumber (string, required)
  productScope (string)

ExternalNumberingPlanRef
Properties:
  displayName (string)
  triggerQuoteState (Enum draft | validated | earlyUnderwritten | priced | underwritten | accepted | issued | underwrittenBlocked | declined | rejected | refused | discarded, required)

RegionRef
Properties:
  displayName (string)
  numberingString (string)

TemplateSnippetConfigRef
Properties:
  displayName (string)
  selectionTimeBasis (Enum policyStartTime | termStartTime | transactionEffectiveTime | currentTime, required)

ScheduleRef
Properties:
  extend (string)
  abstract (boolean)
  displayName (string)
  data (map<string, PropertyRef>, required)
  resetOnRenewal (boolean, required)

LossRef
Properties:
  extend (string)
  abstract (boolean)
  data (map<string, PropertyRef>, required)
  category (string, required)
  coverageTypes (string[])

ClaimRef
Properties:
  extend (string)
  abstract (boolean)
  claimCategory (string, required)

TableRef
Properties:
  columns (map<string, ColumnRef>, required)
  selectionTimeBasis (Enum policyStartTime | termStartTime | transactionEffectiveTime | currentTime, required)

RangeTableRef
Properties:
  columns (map<string, ColumnRef>, required)
  selectionTimeBasis (Enum policyStartTime | termStartTime | transactionEffectiveTime | currentTime, required)
  rangeStart (string, required)
  rangeEnd (string)

ColumnRef
Properties:
  dataType (string, required)
  isKey (boolean, required)

ConstraintTableRef
Properties:
  columns (map<string, ConstraintColumnRef>, required)
  selectionTimeBasis (Enum policyStartTime | termStartTime | transactionEffectiveTime | currentTime, required)

ConstraintColumnRef
Properties:
  dataType (string, required)
  makeDistinct (boolean, required)

DocumentConfigRef
Properties:
  displayName (string)
  scope (Enum transaction | policy | term | segment | invoice, required)
  format (Enum text | html | pdf | jpg | jpeg | doc | docx | xls | xlsx | csv | txt | zip, required)
  rendering (Enum dynamic | prerendered, required)
  selectionTimeBasis (Enum policyStartTime | termStartTime | transactionEffectiveTime | currentTime, required)
  trigger (Enum validated | priced | accepted | underwritten | issued | generated, required)
  portrait (boolean)
  pageSize (Enum letter | legal | A3 | A4 | A5 | B4 | B5)
  margin (DocumentMarginRef)
  templateSnippets (string[], required)
  customFonts (string[], required)

DocumentMarginRef
Properties:
  top (number)
  bottom (number)
  left (number)
  right (number)

ConsolidatedDocumentConfigRef
Properties:
  displayName (string)
  consolidatedDocuments (string[], required)
  leadingDocumentTemplate (string)
  pageNumbering (ConsolidatedPageNumberingRef)

ConsolidatedPageNumberingRef
Properties:
  enableNumbering (boolean, required)
  leadingDocumentPages (boolean, required)
  xPosition (integer, required)
  yPosition (integer, required)

CustomEventRef
Properties:
  type (string, required)
  schedule (EventScheduleRef)

EventScheduleRef
Properties:
  anchor (Enum policyStart | policyEnd | termStart | segmentStart, required)
  alignment (Enum weekStart | monthStart | yearStart)
  offset (map<string, integer>)
  cadence (EventCadenceRef)
  suppressOnStatuses (Enum[])

EventCadenceRef
Properties:
  intervalDuration (integer, required)
  durationBasis (Enum years | months | weeks | days | hours, required)
  limit (integer)

TenantCustomEventRef
Properties:
  type (string, required)
  schedule (TenantEventScheduleRef)
  isPersisted (boolean, required)

TenantEventScheduleRef
Properties:
  alignment (Enum weekStart | monthStart | yearStart)
  offset (map<string, integer>)
  cadence (EventCadenceRef)

SecretRef
Properties:
  items (map<string, PrimitivePropertyRef>, required)

PrimitivePropertyRef
Properties:
  dataType (string, required)

AuxDataSettingsRef
Properties:
  displayName (string)
  expirationPeriod (integer, required)

DataAccessControlRef
Properties:
  enabled (boolean, required)
  dataMasking (boolean, required)
  account (DataAccessControlFieldRef, required)
  policy (DataAccessControlFieldRef, required)

DataAccessControlFieldRef
Properties:
  fields (string[], required)

ContactRef
Properties:
  abstract (boolean)
  extend (string)
  defaultSearchable (boolean)
  data (map<string, PropertyRef>, required)

AutomationPluginRef
Properties:
  enableWebhooks (boolean)
  actions (map<string, AutomationPluginActionRef>)
  secret (string)
  webhookHandlerTimeout (integer)

AutomationPluginActionRef
Properties:
  timeout (integer)
  request (map<string, PropertyRef>)
  response (map<string, PropertyRef>)

ProducerManagementRef
Properties:
  producers (map<string, ProducerRef>, required)
  producerCodes (map<string, ProducerCodeRef>, required)
  producerLicenses (map<string, ProducerLicenseRef>, required)
  producerAppointments (map<string, ProducerAppointmentRef>, required)
  underwritingFlag (UnderwritingFlagRef, required)

UnderwritingFlagRef
Properties:
  level (Enum info | block | decline | reject | approve)
  tag (string)
  note (string)

ProducerCodeRef
Properties:
  displayName (string)
  abstract (boolean, required)
  extend (string, required)
  defaultSearchable (boolean, required)
  numberingPlan (string, required)
  numberingString (string, required)
  data (map<string, PropertyRef>)

ProducerRef
Properties:
  displayName (string)
  abstract (boolean, required)
  extend (string, required)
  defaultSearchable (boolean, required)
  data (map<string, PropertyRef>)

ProducerLicenseRef
Properties:
  abstract (boolean, required)
  extend (string, required)
  defaultSearchable (boolean, required)
  data (map<string, PropertyRef>)

ProducerAppointmentRef
Properties:
  abstract (boolean, required)
  extend (string, required)
  defaultSearchable (boolean, required)
  data (map<string, PropertyRef>)