Configuration Deployments API
| Action | Endpoint |
|---|---|
| Download the Current Configuration | GET/config/{tenantLocator}/deployments/download |
| Download the Configuration for a Version | GET/config/{tenantLocator}/deployments/download/{version} |
| Fetch the Latest Configuration Definition | GET/config/{tenantLocator}/deployments/datamodel |
| Fetch the Configuration Definition for a Version | GET/config/{tenantLocator}/deployments/datamodel/{version} |
| Get Configuration Metadata | GET/config/{tenantLocator}/deployments |
| Redeploy a Configuration | POST/config/{tenantLocator}/deployments/deploy |
| Get a Configuration Payload Difference | GET/config/{tenantLocator}/deployments/diff |
| Validate a Configuration Payload | POST/config/validateConfig |
| Validate a Configuration ZIP Payload | POST/config/{tenantLocator}/deployments/validate |
| Format Config | POST/config/formatConfig |
Tenant Creation
Create a Tenant
Create a Tenant
createTenantPOST
/config/createTenantParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
name | query | string? | No | |
description | query | string? | No |
Request with application/zip:
ConfigurationRefRequest with multipart/form-data:
ConfigurationRefResponse:
TenantDeploymentResultSecurity Group:
tenantsPermission:
create-tenantTenantDeploymentResult
Required properties
| Property | Type | Description |
|---|---|---|
locator | uuid | |
name | string | |
bootstrapResult | BootstrapResult | |
deploymentResult | ConfigBuilderResult |
Fetch
Download the Current Configuration
Download the Current Configuration
downloadCurrentConfigurationGET
/config/{tenantLocator}/deployments/downloadParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes |
Response:
StreamingResponseBody<ZipFile>Security Group:
deploymentsPermission:
deployDownload the Configuration for a Version
Download the Configuration for a Version
downloadConfigurationVersionGET
/config/{tenantLocator}/deployments/download/{version}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
version | path | ulid | Yes | |
byStaticLocator | query | boolean? | No |
Response:
StreamingResponseBody<ZipFile>Security Group:
deploymentsPermission:
deployFetch the Latest Configuration Definition
Fetch the Latest Configuration Definition
fetchConfigDefinitionGET
/config/{tenantLocator}/deployments/datamodelParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
resolve | query | boolean? | No |
Response:
ConfigurationRefSecurity Group:
deploymentsPermissions:
deploy,datamodelFetch the Configuration Definition for a Version
Fetch the Configuration Definition for a Version
fetchConfigDefinitionForAVersionGET
/config/{tenantLocator}/deployments/datamodel/{version}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
version | path | ulid | Yes | |
resolve | query | boolean? | No | |
byStaticLocator | query | boolean? | No |
Response:
ConfigurationRefSecurity Group:
deploymentsPermissions:
deploy,datamodelGet Configuration Metadata
Get Configuration Metadata
getDeployedConfigMetadataGET
/config/{tenantLocator}/deploymentsParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes |
Response:
DeployedConfigMetadataSecurity Group:
deploymentsPermission:
readDeployedConfigMetadata
Required properties
| Property | Type | Description |
|---|---|---|
metadata | DeploymentMetadata | |
pluginStatus | map<string, string> | |
pluginVersionStatus | map<string, map<string, string>>Deprecated |
Optional properties
| Property | Type | Description |
|---|---|---|
expectedRetirementTime | datetime? |
Redeployment
Redeploy a Configuration
Redeploy a Configuration
deployConfigZipPOST
/config/{tenantLocator}/deployments/deployParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
overwrite | query | boolean? | No |
Request with application/zip:
ConfigurationRefRequest with multipart/form-data:
ConfigurationRefResponse:
TenantDeploymentResultSecurity Group:
deploymentsPermission:
deployGet a Configuration Payload Difference
Get a Configuration Payload Difference
getPartialDeployDifferenceGET
/config/{tenantLocator}/deployments/diffParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
config | query | ConfigurationRef | Yes |
Response:
map<string, MapDifference>Security Group:
deploymentsPermission:
deployMapDifference
Required properties
| Property | Type | Description |
|---|---|---|
added | map<string, object> | |
modified | map<string, object> | |
removed | map<string, object> |
Validation
Validate a Configuration Payload
Validate a Configuration Payload
validateConfigPOST
/config/validateConfigRequest with application/zip:
ConfigurationRefRequest with multipart/form-data:
ConfigurationRefResponse:
StreamingResponseBody<ZipFile>Security Group:
tenantsPermissions:
create-tenant,validate-configValidate a Configuration ZIP Payload
Validate a Configuration ZIP Payload
validateConfigZipPOST
/config/{tenantLocator}/deployments/validateParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes |
Request with application/zip:
ConfigurationRefRequest with multipart/form-data:
ConfigurationRefResponse:
StreamingResponseBody<ZipFile>Security Group:
deploymentsPermission:
deployUtility
Format Config
Format Config
formatConfigPOST
/config/formatConfigConverts a configuration's property casing to match requirements
Request with application/zip:
ConfigurationRefRequest with multipart/form-data:
ConfigurationRefResponse:
StreamingResponseBody<ZipFile>Security Group:
tenantsPermissions:
create-tenant,validate-configConfiguration Entities
ConfigurationRef
Required properties
| Property | Type | Description |
|---|---|---|
accounts | map<string, AccountRef> | |
charges | map<string, ChargeRef> | |
products | map<string, ProductRef> |
Optional properties
| Property | Type | Description |
|---|---|---|
defaultDisbursementNumberingPlanName | string? | |
defaultPaymentNumberingPlanName | string? | |
assistant | AssistantRef? | |
bootstrap | BootstrapRef? | |
dataAccessControl | DataAccessControlRef? | |
defaultAutoRenewalPlan | string? | |
defaultAuxDataSettings | string? | |
defaultBackdatedInstallmentsBilling | Enum? immediate | deferDueDate | |
defaultCurrency | string? | |
defaultDelinquencyPlan | string? | |
defaultDurationBasis | Enum? years | months | weeks | days | hours | |
defaultExcessCreditPlan | string? | |
defaultInstallmentPlan | string? | |
defaultInvoiceDocument | string? | |
defaultInvoicingPlan | string? | |
defaultRetryPlan | string? | |
defaultScheduleUploadErrorsLimit | integer? | |
defaultSearchable | boolean? | Default is true |
defaultShortfallTolerancePlan | string? | |
defaultTermDuration | number? | |
defaultTimeZone | string? | |
enableEntityAnonymization | boolean? | |
enableSerialInvoiceNumbering | boolean? | |
producerManagement | ProducerManagementRef? | |
workManagement | WorkManagementRef? | |
automations | map<string, AutomationPluginRef>? | |
autoRenewalPlans | map<string, AutoRenewalPlanRef>? | |
auxDataSettings | map<string, AuxDataSettingsRef>? | |
claims | map<string, ClaimRef>? | |
consolidatedDocuments | map<string, ConsolidatedDocumentConfigRef>? | |
constraintTables | map<string, ConstraintTableRef>? | |
contactRoles | string[]? | |
contacts | map<string, ContactRef>? | |
coverages | map<string, ElementRef>? | |
coverageTerms | map<string, CoverageTermRef>? | |
customEvents | map<string, CustomEventRef>? | |
customFonts | string[]? | |
dataTypes | map<string, DataTypeRef>? | |
delinquencyPlans | map<string, DelinquencyPlanRef>? | |
disbursements | map<string, DisbursementRef>? | |
documents | map<string, DocumentConfigRef>? | |
excessCreditPlans | map<string, ExcessCreditPlanRef>? | |
exposureGroups | map<string, ElementRef>? | |
exposures | map<string, ElementRef>? | |
externalNumberingPlans | map<string, ExternalNumberingPlanRef>? | |
fnol | map<string, FnolRef>? | |
installmentPlans | map<string, InstallmentPlanRef>? | |
invoicingPlans | map<string, InvoicingPlanRef>? | |
jurisdictions | map<string, JurisdictionRef>? | |
lossCategories | string[]? | |
losses | map<string, LossRef>? | |
moratoriums | map<string, MoratoriumRef>? | |
numberingPlans | map<string, NumberingPlanRef>? | |
payments | map<string, PaymentRef>? | |
policyLines | map<string, ElementRef>? | |
rangeTables | map<string, RangeTableRef>? | |
regions | map<string, RegionRef>? | |
retryPlans | map<string, RetryPlanRef>? | |
reversalTypes | map<string, ReversalTypeRef>? | |
schedules | map<string, ScheduleRef>? | |
secrets | map<string, SecretRef>? | |
shortfallTolerancePlans | map<string, ShortfallTolerancePlanRef>? | |
tables | map<string, TableRef>? | |
templateSnippets | map<string, TemplateSnippetConfigRef>? | |
tenantCustomEvents | map<string, TenantCustomEventRef>? | |
transactionTypes | map<string, TransactionTypeRef>? | |
defaultAnchorMode | Enum? generateDay | termStartDay | dueDayDeprecated | |
defaultBillingLevel | Enum? account | inherit | policyDeprecated | |
defaultBillingPlan | string?Deprecated | |
defaultDueLeadDays | integer?Deprecated | |
defaultGenerateLeadDays | integer?Deprecated | |
defaultLapseType | string?Deprecated | |
defaultRegion | string?Deprecated | |
billingPlans | map<string, BillingPlanRef>?Deprecated |
BootstrapRef
Required properties
| Property | Type | Description |
|---|---|---|
resources | ResourcesRef |
ResourcesRef
Required properties
| Property | Type | Description |
|---|---|---|
resourceGroups | map<string, ResourceGroupRef> | |
resourceInstances | map<string, ResourceInstanceRef> |
ResourceInstanceRef
Required properties
| Property | Type | Description |
|---|---|---|
staticName | string | |
jurisdictions | string[] |
ResourceGroupRef
Required properties
| Property | Type | Description |
|---|---|---|
selectionStartTime | datetime | |
resourceNames | string[] |
JurisdictionRef
Properties
| Property | Type | Description |
|---|---|---|
displayHints | DisplayHintsRef? |
ConfigBuilderResult
Required properties
| Property | Type | Description |
|---|---|---|
isSuccess | boolean | |
metadata | DeploymentMetadata | |
errors | string[] |
BootstrapResult
Required properties
| Property | Type | Description |
|---|---|---|
error | string | |
status | Enum queued | failed |
DeploymentMetadata
Required properties
| Property | Type | Description |
|---|---|---|
latestVersion | ulid | |
version1 | ulid | |
implementedAutomationPlugins | map<string, string> | |
implementedPlugins | map<string, string> | |
version2 | ulidDeprecated |
Optional properties
| Property | Type | Description |
|---|---|---|
staticVersionLocator | ulid? |
TransactionTypeRef
Required properties
| Property | Type | Description |
|---|---|---|
category | Enum issuance | change | renewal | cancellation | reinstatement | reversal | aggregate | |
costBearing | boolean |
Optional properties
| Property | Type | Description |
|---|---|---|
displayHints | DisplayHintsRef? | |
data | map<string, PropertyRef>? |
AccountRef
Required properties
| Property | Type | Description |
|---|---|---|
data | map<string, PropertyRef> |
Optional properties
| Property | Type | Description |
|---|---|---|
displayName | string? | |
abstract | boolean? | |
accountKind | Enum? standard | proxyPayer | |
defaultInvoiceDocument | string? | |
defaultSearchable | boolean? | |
extend | string? | |
invoiceNumberingPlan | string? | |
numberingPlan | string? | |
numberingTrigger | Enum? creation | validation | |
paymentExecutionRetryPlan | string? | |
contacts | map<string, string[]>? |
ProductRef
Properties
| Property | Type | Description |
|---|---|---|
displayName | string? | |
abstract | boolean? | |
availability | AvailabilityRef? | |
defaultAutoRenewalPlan | string? | |
defaultDelinquencyPlan | string? | |
defaultDurationBasis | Enum? years | months | weeks | days | hours | |
defaultInstallmentPlan | string? | |
defaultSearchable | boolean? | |
defaultShortfallTolerancePlan | string? | |
defaultTermDuration | number? | |
extend | string? | |
externalNumberingPlan | string? | |
numberingPlan | string? | |
numberingString | string? | |
numberingTrigger | Enum? creation | validation | |
producerQualification | Enum? none | license | appointment | |
requiresJurisdiction | boolean? | |
reservedPolicyNumberRequired | boolean? | |
riskAssessmentCriteria | string? | |
withPrecommitReapplication | boolean? | |
data | map<string, PropertyRef>? | |
charges | string[]? | |
contacts | map<string, string[]>? | |
contents | string[]? | |
coverageTerms | string[]? | |
documents | string[]? | |
eligibleAccountTypes | string[]? | |
eligibleTransactionTypes | string[]? | |
scheduledEvents | string[]? | |
staticData | map<string, PropertyRef>? | |
workplanTriggers | map<string, string[]>? | |
defaultBillingPlan | string?Deprecated | |
pluralType | string?Deprecated |
ElementRef
Properties
| Property | Type | Description |
|---|---|---|
displayName | string? | |
abstract | boolean? | |
availability | AvailabilityRef? | |
defaultSearchable | boolean? | |
extend | string? | |
schedule | string? | |
data | map<string, PropertyRef>? | |
charges | string[]? | |
contents | string[]? | |
coverageTerms | string[]? | |
pluralType | string?Deprecated |
CoverageTermRef
Required properties
| Property | Type | Description |
|---|---|---|
type | Enum splitLimit | deductible | limit |
Optional properties
| Property | Type | Description |
|---|---|---|
displayName | string? | |
availability | AvailabilityRef? | |
value | PropertyRef? | |
options | map<string, CoverageTermOptionRef>? |
CoverageTermOptionRef
Required properties
| Property | Type | Description |
|---|---|---|
value | number |
Optional properties
| Property | Type | Description |
|---|---|---|
displayName | string? | |
displayHints | DisplayHintsRef? | |
tag | string? |
DisplayHintsRef
Properties
| Property | Type | Description |
|---|---|---|
displayName | string? | |
displayOrder | integer? |
FnolRef
Required properties
| Property | Type | Description |
|---|---|---|
data | map<string, PropertyRef> |
Optional properties
| Property | Type | Description |
|---|---|---|
abstract | boolean? | |
defaultSearchable | boolean? | |
extend | string? | |
numberingPlan | string? | |
contacts | map<string, string[]>? | |
lossTypes | string[]? |
WorkManagementRef
Properties
| Property | Type | Description |
|---|---|---|
qualifications | map<string, string[]>? | |
tasks | map<string, TaskTypeRef>? | |
userAssociationRoles | map<string, UserAssociationRoleRef>? |
TaskTypeRef
Required properties
| Property | Type | Description |
|---|---|---|
blocksUnderwriting | boolean | |
defaultDeadlineDays | number |
Optional properties
| Property | Type | Description |
|---|---|---|
numberingPlan | string? | |
numberingString | string? |
UserAssociationRoleRef
Properties
| Property | Type | Description |
|---|---|---|
exclusive | boolean? | |
appliesTo | Enum[]? account | quickQuote | quote | policy | transaction | invoice | underwritingFlag | payment | quoteGroup | inquiry | |
qualification | map<string, string>? |
DataTypeRef
Required properties
| Property | Type | Description |
|---|---|---|
data | map<string, PropertyRef> |
Optional properties
| Property | Type | Description |
|---|---|---|
displayName | string? | |
abstract | boolean? | |
defaultSearchable | boolean? | |
extend | string? |
AvailabilityRef
Specifies availability. At least one of availableAfter, retireAfter, retire, removeOnRenewalAfter, or removeOnRenewal must be set.
Required properties
| Property | Type | Description |
|---|---|---|
availabilityTimeBasis | Enum policyStartTime | termStartTime | default: TermStartTime |
retirementTimeBasis | Enum policyStartTime | termStartTime | default: TermStartTime |
Optional properties
| Property | Type | Description |
|---|---|---|
availableAfter | datetime? | |
removeOnRenewal | boolean? | default: false |
removeOnRenewalAfter | datetime? | |
retire | boolean? | default: false |
retireAfter | datetime? |
PropertyRef
Properties
| Property | Type | Description |
|---|---|---|
displayName | string? | |
availability | AvailabilityRef? | |
constraint | PropertyConstraint? | |
defaultValue | string? | |
max | string? | |
maxLength | integer? | |
min | string? | |
minLength | integer? | |
precision | integer? | |
regex | string? | |
restrictedData | RestrictedDataRef? | |
roundingMode | Enum? ceiling | down | floor | halfDown | halfEven | halfUp | up | |
scope | string? | |
searchable | boolean? | |
type | string? | |
options | string[]? | |
tag | string[]? |
PropertyConstraint
Required properties
| Property | Type | Description |
|---|---|---|
column | string | |
table | string | |
where | map<string, ConditionValueRef> |
ConditionValueRef
Required properties
| Property | Type | Description |
|---|---|---|
key | string | |
values | string[] |
RestrictedDataRef
Required properties
| Property | Type | Description |
|---|---|---|
anonymizable | boolean | |
maskingLevel | Enum none | level1 | level2 | |
value | Values |
Values
Required properties
| Property | Type | Description |
|---|---|---|
date | date | |
datetime | datetime | |
decimal | number | |
guid | string | |
int | integer | |
long | integer | |
string | string |
ChargeRef
Required properties
| Property | Type | Description |
|---|---|---|
category | Enum none | premium | tax | fee | credit | invoiceFee | cededPremium | nonFinancial | surcharge | |
handling | Enum flat | normal | retention | |
invoicing | Enum scheduled | next | immediate | |
transactionBundlingEnabled | boolean |
Optional properties
| Property | Type | Description |
|---|---|---|
displayName | string?Deprecated |
BillingPlanRef
Required properties
| Property | Type | Description |
|---|---|---|
billingLevel | Enum account | inherit | policy |
Optional properties
| Property | Type | Description |
|---|---|---|
displayName | string? |
DelinquencyPlanRef
Required properties
| Property | Type | Description |
|---|---|---|
gracePeriodDays | integer |
Optional properties
| Property | Type | Description |
|---|---|---|
displayName | string? | |
advanceLapseTo | Enum? draft | validated | priced | underwritten | accepted | issued | |
delinquencyLevel | Enum? policy | invoice | |
lapseTransactionType | string? | |
events | map<string, DelinquencyEventConfiguration>? |
DelinquencyEventConfiguration
Required properties
| Property | Type | Description |
|---|---|---|
offsetBasis | Enum gracePeriodStart | gracePeriodEnd | |
offsetDays | number |
InstallmentPlanRef
Required properties
| Property | Type | Description |
|---|---|---|
anchorMode | Enum generateDay | termStartDay | dueDay | |
cadence | Enum none | fullPay | weekly | everyOtherWeek | monthly | quarterly | semiannually | annually | thirtyDays | everyNDays | |
dueLeadDays | integer | |
generateLeadDays | integer | |
maxInstallmentsPerTerm | integer | |
installmentWeights | number[] |
Optional properties
| Property | Type | Description |
|---|---|---|
displayName | string? | |
autopayLeadDays | number? |
InvoicingPlanRef
Required properties
| Property | Type | Description |
|---|---|---|
consolidateInvoicesOnCancellation | Enum none | future | all | |
installmentGrouping | InstallmentGroupingDetails | |
invoiceFeeHandling | Enum max | min | sum | waive | |
invoiceFeeAmounts | map<string, number> |
Optional properties
| Property | Type | Description |
|---|---|---|
displayName | string? |
InstallmentGroupingDetails
Required properties
| Property | Type | Description |
|---|---|---|
matching | Enum generateTime | startTime | all | Default is generateTime |
window | Enum start | startAndEnd | catchUp | Default is startAndEnd |
AutoRenewalPlanRef
Required properties
| Property | Type | Description |
|---|---|---|
generateAutoRenewals | boolean |
Optional properties
| Property | Type | Description |
|---|---|---|
newTermDuration | integer? | |
renewalAcceptLeadDays | integer? | |
renewalCreateLeadDays | integer? | |
renewalIssueLeadDays | integer? | |
renewalTransactionType | string? |
RetryPlanRef
Required properties
| Property | Type | Description |
|---|---|---|
attempts | integer | |
hoursBetweenAttempts | number[] |
PaymentRef
Required properties
| Property | Type | Description |
|---|---|---|
abstract | boolean | |
defaultSearchable | boolean | |
extend | string | |
numberingPlan | string | |
numberingTrigger | Enum creation | validation |
Optional properties
| Property | Type | Description |
|---|---|---|
displayName | string? | |
data | map<string, PropertyRef>? |
DisbursementRef
Required properties
| Property | Type | Description |
|---|---|---|
data | map<string, PropertyRef> |
Optional properties
| Property | Type | Description |
|---|---|---|
displayName | string? | |
abstract | boolean? | |
extend | string? | |
numberingPlan | string? | |
numberingTrigger | Enum? creation | validation |
ReversalTypeRef
Required properties
| Property | Type | Description |
|---|---|---|
creditType | Enum any | creditDistribution | payment |
ShortfallTolerancePlanRef
Required properties
| Property | Type | Description |
|---|---|---|
currencyTolerances | map<string, number> |
ExcessCreditPlanRef
Required properties
| Property | Type | Description |
|---|---|---|
advanceDisbursementTo | Enum draft | validated | approved | executed | reversed | rejected | discarded | |
autoApplyExcessToInvoicesEnabled | boolean | |
disburseExcess | boolean | Set to true to enable excess funds handling for the plan. |
disbursementType | string | The type of the disbursement to be automatically created. |
excludeDebits | Enum allInvoices | invoicesAndUnbilledInstallments | none | pastDueInvoices | Which pending debits should be considered for determining how much of the credit to retain |
negativeInvoiceHandling | NegativeInvoiceHandlingRef | |
disbursementThresholds | map<string, number> |
NegativeInvoiceHandlingRef
Required properties
| Property | Type | Description |
|---|---|---|
automaticallySettleNegativeInvoices | Enum toOpenInvoices | toCreditBalance | never | |
prioritizeOverlappingCoveragePeriods | boolean | |
processingMode | Enum accountLevel | policyLevel | |
targetInvoicePriority | Enum byAmount | smallestFirst | earliestFirst | |
targetInvoices | Enum overlappingCoveragePeriodsOnly | overlappingCoverageAndEarlier | allOpenInvoices | |
yieldExcessToCreditBalance | boolean |
NumberingPlanRef
Required properties
| Property | Type | Description |
|---|---|---|
copyFromQuote | boolean | |
format | string | |
initialCoreNumber | string | |
initialQuoteCoreNumber | string | |
quoteNumberFormat | string | |
termNumberFormat | string |
Optional properties
| Property | Type | Description |
|---|---|---|
displayName | string? | |
productScope | string? |
ExternalNumberingPlanRef
Required properties
| Property | Type | Description |
|---|---|---|
triggerQuoteState | Enum draft | validated | earlyUnderwritten | priced | underwritten | accepted | issued | underwrittenBlocked | declined | rejected | refused | discarded |
Optional properties
| Property | Type | Description |
|---|---|---|
displayName | string? |
RegionRef
Properties
| Property | Type | Description |
|---|---|---|
displayName | string? | |
numberingString | string? |
TemplateSnippetConfigRef
Required properties
| Property | Type | Description |
|---|---|---|
selectionTimeBasis | Enum policyStartTime | termStartTime | transactionEffectiveTime | currentTime |
Optional properties
| Property | Type | Description |
|---|---|---|
displayName | string? |
ScheduleRef
Required properties
| Property | Type | Description |
|---|---|---|
resetOnRenewal | boolean | |
data | map<string, PropertyRef> |
Optional properties
| Property | Type | Description |
|---|---|---|
displayName | string? | |
abstract | boolean? | |
extend | string? |
LossRef
Required properties
| Property | Type | Description |
|---|---|---|
category | string | |
data | map<string, PropertyRef> |
Optional properties
| Property | Type | Description |
|---|---|---|
abstract | boolean? | |
extend | string? | |
coverageTypes | string[]? |
ClaimRef
Required properties
| Property | Type | Description |
|---|---|---|
claimCategory | string |
Optional properties
| Property | Type | Description |
|---|---|---|
abstract | boolean? | |
extend | string? |
TableRef
Required properties
| Property | Type | Description |
|---|---|---|
selectionTimeBasis | Enum policyStartTime | termStartTime | transactionEffectiveTime | currentTime | |
columns | map<string, ColumnRef> |
RangeTableRef
Required properties
| Property | Type | Description |
|---|---|---|
rangeStart | string | |
selectionTimeBasis | Enum policyStartTime | termStartTime | transactionEffectiveTime | currentTime | |
columns | map<string, ColumnRef> |
Optional properties
| Property | Type | Description |
|---|---|---|
rangeEnd | string? |
ColumnRef
Required properties
| Property | Type | Description |
|---|---|---|
dataType | string | |
isKey | boolean |
ConstraintTableRef
Required properties
| Property | Type | Description |
|---|---|---|
selectionTimeBasis | Enum policyStartTime | termStartTime | transactionEffectiveTime | currentTime | |
columns | map<string, ConstraintColumnRef> |
ConstraintColumnRef
Required properties
| Property | Type | Description |
|---|---|---|
dataType | string | |
makeDistinct | boolean |
DocumentConfigRef
Required properties
| Property | Type | Description |
|---|---|---|
format | Enum text | html | pdf | jpg | jpeg | doc | docx | xls | xlsx | csv | txt | zip | |
rendering | Enum dynamic | prerendered | |
scope | Enum transaction | policy | term | segment | invoice | |
selectionTimeBasis | Enum policyStartTime | termStartTime | transactionEffectiveTime | currentTime | |
trigger | Enum validated | priced | accepted | underwritten | issued | generated | declined | rejected | refused | |
customFonts | string[] | |
templateSnippets | string[] |
Optional properties
| Property | Type | Description |
|---|---|---|
displayName | string? | |
margin | DocumentMarginRef? | |
pageSize | Enum? letter | legal | A3 | A4 | A5 | B4 | B5 | |
portrait | boolean? |
AssistantRef
Properties
| Property | Type | Description |
|---|---|---|
patTokenSecretRef | SecretKeyRef? | |
inquiryIntents | map<string, IntentPlan>? |
IntentPlan
Required properties
| Property | Type | Description |
|---|---|---|
intentType | string | |
taskType | string |
Optional properties
| Property | Type | Description |
|---|---|---|
workgroup | string? |
SecretKeyRef
Required properties
| Property | Type | Description |
|---|---|---|
name | string | |
key | string |
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.
DocumentMarginRef
Properties
| Property | Type | Description |
|---|---|---|
bottom | number? | |
left | number? | |
right | number? | |
top | number? |
The bottom, left, right and top properties represent the size of the
margin in millimeters.
ConsolidatedDocumentConfigRef
Required properties
| Property | Type | Description |
|---|---|---|
consolidatedDocuments | string[] |
Optional properties
| Property | Type | Description |
|---|---|---|
displayName | string? | |
leadingDocumentTemplate | string? | |
pageNumbering | ConsolidatedPageNumberingRef? |
ConsolidatedPageNumberingRef
Required properties
| Property | Type | Description |
|---|---|---|
enableNumbering | boolean | |
leadingDocumentPages | boolean | |
xPosition | integer | |
yPosition | integer |
CustomEventRef
Required properties
| Property | Type | Description |
|---|---|---|
type | string |
Optional properties
| Property | Type | Description |
|---|---|---|
schedule | EventScheduleRef? |
EventScheduleRef
Required properties
| Property | Type | Description |
|---|---|---|
anchor | Enum policyStart | policyEnd | termStart | segmentStart |
Optional properties
| Property | Type | Description |
|---|---|---|
alignment | Enum? weekStart | monthStart | yearStart | |
cadence | EventCadenceRef? | |
offset | map<string, integer>? | |
suppressOnStatuses | Enum[]? pending | expired | cancelled | cancelPending | onRisk | delinquent | doNotRenew |
EventCadenceRef
Required properties
| Property | Type | Description |
|---|---|---|
durationBasis | Enum years | months | weeks | days | hours | |
intervalDuration | integer |
Optional properties
| Property | Type | Description |
|---|---|---|
limit | integer? |
TenantCustomEventRef
Required properties
| Property | Type | Description |
|---|---|---|
isPersisted | boolean | |
type | string |
Optional properties
| Property | Type | Description |
|---|---|---|
schedule | TenantEventScheduleRef? |
TenantEventScheduleRef
Properties
| Property | Type | Description |
|---|---|---|
alignment | Enum? weekStart | monthStart | yearStart | |
cadence | EventCadenceRef? | |
offset | map<string, integer>? |
SecretRef
Required properties
| Property | Type | Description |
|---|---|---|
items | map<string, PrimitivePropertyRef> |
PrimitivePropertyRef
Required properties
| Property | Type | Description |
|---|---|---|
dataType | string |
AuxDataSettingsRef
Required properties
| Property | Type | Description |
|---|---|---|
expirationPeriod | integer |
Optional properties
| Property | Type | Description |
|---|---|---|
displayName | string? |
DataAccessControlRef
Required properties
| Property | Type | Description |
|---|---|---|
account | DataAccessControlFieldRef | |
dataMasking | boolean | |
enabled | boolean | |
policy | DataAccessControlFieldRef |
DataAccessControlFieldRef
Required properties
| Property | Type | Description |
|---|---|---|
fields | string[] |
ContactRef
Required properties
| Property | Type | Description |
|---|---|---|
data | map<string, PropertyRef> |
Optional properties
| Property | Type | Description |
|---|---|---|
abstract | boolean? | |
defaultSearchable | boolean? | |
extend | string? |
AutomationPluginRef
Properties
| Property | Type | Description |
|---|---|---|
enableWebhooks | boolean? | |
secret | string? | |
webhookHandlerTimeout | integer? | |
actions | map<string, AutomationPluginActionRef>? |
AutomationPluginActionRef
Properties
| Property | Type | Description |
|---|---|---|
timeout | integer? | |
request | map<string, PropertyRef>? | |
response | map<string, PropertyRef>? |
ProducerManagementRef
Required properties
| Property | Type | Description |
|---|---|---|
underwritingFlag | UnderwritingFlagRef | |
producerAppointments | map<string, ProducerAppointmentRef> | |
producerCodes | map<string, ProducerCodeRef> | |
producerLicenses | map<string, ProducerLicenseRef> | |
producers | map<string, ProducerRef> |
UnderwritingFlagRef
Properties
| Property | Type | Description |
|---|---|---|
level | Enum? info | block | decline | reject | approve | |
note | string? | |
tag | string? |
ProducerCodeRef
Required properties
| Property | Type | Description |
|---|---|---|
abstract | boolean | |
defaultSearchable | boolean | |
extend | string | |
numberingPlan | string | |
numberingString | string |
Optional properties
| Property | Type | Description |
|---|---|---|
displayName | string? | |
data | map<string, PropertyRef>? |
ProducerRef
Required properties
| Property | Type | Description |
|---|---|---|
abstract | boolean | |
defaultSearchable | boolean | |
extend | string |
Optional properties
| Property | Type | Description |
|---|---|---|
displayName | string? | |
data | map<string, PropertyRef>? |
ProducerLicenseRef
Required properties
| Property | Type | Description |
|---|---|---|
abstract | boolean | |
defaultSearchable | boolean | |
extend | string |
Optional properties
| Property | Type | Description |
|---|---|---|
data | map<string, PropertyRef>? |
ProducerAppointmentRef
Required properties
| Property | Type | Description |
|---|---|---|
abstract | boolean | |
defaultSearchable | boolean | |
extend | string |
Optional properties
| Property | Type | Description |
|---|---|---|
data | map<string, PropertyRef>? |