Configuration Deployments API

Endpoint Index

ActionEndpoint
Download the Current ConfigurationGET /config/{tenantLocator}/deployments/download
Download the Configuration for a VersionGET /config/{tenantLocator}/deployments/download/{version}
Fetch the Latest Configuration DefinitionGET /config/{tenantLocator}/deployments/datamodel
Fetch the Configuration Definition for a VersionGET /config/{tenantLocator}/deployments/datamodel/{version}
Get Configuration MetadataGET /config/{tenantLocator}/deployments
Redeploy a ConfigurationPOST /config/{tenantLocator}/deployments/deploy
Get a Configuration Payload DifferenceGET /config/{tenantLocator}/deployments/diff
Validate a Configuration PayloadPOST /config/validateConfig
Validate a Configuration ZIP PayloadPOST /config/{tenantLocator}/deployments/validate
Format ConfigPOST /config/formatConfig

Tenant Creation

Create a Tenant
createTenant
POST /config/createTenant
    Request Parameters:
    NamePositionTypeRequired
    namequerystring?optional
    descriptionquerystring?optional
    Request with application/zip:ConfigurationRef
    Request with multipart/form-data:ConfigurationRef
    Response:TenantDeploymentResult
    Security Group:tenants   Permission:create-tenant
TenantDeploymentResult
required
locator uuid
name string
bootstrapResult BootstrapResult
deploymentResult ConfigBuilderResult

Fetch

Download the Current Configuration
downloadCurrentConfiguration
GET /config/{tenantLocator}/deployments/download
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    Response:StreamingResponseBody<ZipFile>
    Security Group:deployments   Permission:deploy
Download the Configuration for a Version
downloadConfigurationVersion
GET /config/{tenantLocator}/deployments/download/{version}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    versionpathstringrequired
    byStaticLocatorqueryboolean?optional
    Response:StreamingResponseBody<ZipFile>
    Security Group:deployments   Permission:deploy
Fetch the Latest Configuration Definition
fetchConfigDefinition
GET /config/{tenantLocator}/deployments/datamodel
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    resolvequeryboolean?optional
    Response:ConfigurationRef
    Security Group:deployments   Permissions:deploy,datamodel
Fetch the Configuration Definition for a Version
fetchConfigDefinitionForAVersion
GET /config/{tenantLocator}/deployments/datamodel/{version}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    versionpathstringrequired
    resolvequeryboolean?optional
    byStaticLocatorqueryboolean?optional
    Response:ConfigurationRef
    Security Group:deployments   Permissions:deploy,datamodel
Get Configuration Metadata
getDeployedConfigMetadata
GET /config/{tenantLocator}/deployments
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    Response:DeployedConfigMetadata
    Security Group:deployments   Permission:read
DeployedConfigMetadata
required
metadata DeploymentMetadata
pluginStatus map<string,string>
pluginVersionStatus map<string,map<string,string>> (deprecated)

optional
expectedRetirementTime datetime?

Redeployment

Redeploy a Configuration
deployConfigZip
POST /config/{tenantLocator}/deployments/deploy
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    overwritequeryboolean?optional
    Request with application/zip:ConfigurationRef
    Request with multipart/form-data:ConfigurationRef
    Response:TenantDeploymentResult
    Security Group:deployments   Permission:deploy
Get a Configuration Payload Difference
getPartialDeployDifference
GET /config/{tenantLocator}/deployments/diff
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    configqueryConfigurationRefrequired
    Response:map<string,MapDifference>
    Security Group:deployments   Permission:deploy
MapDifference
required
added map<string,object>
modified map<string,object>
removed map<string,object>

Validation

Validate a Configuration Payload
validateConfig
POST /config/validateConfig
    Request with application/zip:ConfigurationRef
    Request with multipart/form-data:ConfigurationRef
    Response:StreamingResponseBody<ZipFile>
    Security Group:tenants   Permissions:create-tenant,validate-config
Validate a Configuration ZIP Payload
validateConfigZip
POST /config/{tenantLocator}/deployments/validate
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    Request with application/zip:ConfigurationRef
    Request with multipart/form-data:ConfigurationRef
    Response:StreamingResponseBody<ZipFile>
    Security Group:deployments   Permission:deploy

Utility

Format Config
formatConfig
Converts a configuration's property casing to match requirements
POST /config/formatConfig
    Request with application/zip:ConfigurationRef
    Request with multipart/form-data:ConfigurationRef
    Response:StreamingResponseBody<ZipFile>
    Security Group:tenants   Permissions:create-tenant,validate-config

Configuration Entities

ConfigurationRef
required
accounts map<string,AccountRef>
charges map<string,ChargeRef>
products map<string,ProductRef>

optional
defaultDisbursementNumberingPlanName string?
defaultPaymentNumberingPlanName string?
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 int?
defaultSearchable boolean?
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>?
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>?
transactionTypes map<string,TransactionTypeRef>?
defaultAnchorMode Enum? generateDay | termStartDay | dueDay (deprecated)
defaultBillingLevel Enum? account | inherit | policy (deprecated)
defaultBillingPlan string? (deprecated)
defaultBillingTrigger Enum? accept | issue (deprecated)
defaultDueLeadDays int? (deprecated)
defaultGenerateLeadDays int? (deprecated)
defaultLapseType string? (deprecated)
defaultRegion string? (deprecated)
billingPlans map<string,anyOf<BillingPlanRef>>? (deprecated)
BootstrapRef
required
resources ResourcesRef
ResourcesRef
required
resourceGroups map<string,ResourceGroupRef>
resourceInstances map<string,ResourceInstanceRef>
ResourceInstanceRef
required
staticName string
jurisdictions string[]
ResourceGroupRef
required
selectionStartTime datetime
resourceNames string[]
JurisdictionRef
optional
displayHints DisplayHintsRef?
ConfigBuilderResult
required
isSuccess boolean
metadata DeploymentMetadata
errors string[]
BootstrapResult
required
error string
status Enum queued | failed
DeploymentMetadata
required
latestVersion string
version1 string
implementedAutomationPlugins map<string,string>
implementedPlugins map<string,string>
version2 string (deprecated)
TransactionTypeRef
required
category Enum issuance | change | renewal | cancellation | reinstatement | reversal | aggregate
costBearing boolean

optional
displayHints DisplayHintsRef?
AccountRef
required
data map<string,PropertyRef>

optional
displayName string?
abstract boolean?
defaultInvoiceDocument string?
defaultSearchable boolean?
extend string?
invoiceNumberingPlan string?
numberingPlan string?
numberingTrigger Enum? creation | validation
paymentExecutionRetryPlan string?
contacts map<string,string[]>?
ProductRef
optional
displayName string?
abstract boolean?
availability AvailabilityRef?
defaultAutoRenewalPlan string?
defaultBillingTrigger Enum? accept | issue
defaultDelinquencyPlan string?
defaultDurationBasis Enum? years | months | weeks | days | hours
defaultInstallmentPlan string?
defaultSearchable boolean?
defaultShortfallTolerancePlan string?
defaultTermDuration number?
extend string?
numberingPlan string?
numberingString string?
numberingTrigger Enum? creation | validation
requiresJurisdiction 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
optional
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
type Enum splitLimit | deductible | limit

optional
displayName string?
availability AvailabilityRef?
value PropertyRef?
options map<string,CoverageTermOptionRef>?
CoverageTermOptionRef
required
value number

optional
displayName string?
displayHints DisplayHintsRef?
tag string?
DisplayHintsRef
optional
displayName string?
displayOrder int?
FnolRef
required
data map<string,PropertyRef>

optional
abstract boolean?
defaultSearchable boolean?
extend string?
numberingPlan string?
contacts map<string,string[]>?
lossTypes string[]?
WorkManagementRef
optional
qualifications map<string,string[]>?
tasks map<string,map<string,TaskTypeRef>>?
userAssociationRoles map<string,UserAssociationRoleRef>?
TaskTypeRef
required
blocksUnderwriting boolean
defaultDeadlineDays number

optional
numberingPlan string?
numberingString string?
UserAssociationRoleRef
optional
exclusive boolean?
appliesTo Enum[]? account | quickQuote | quote | policy | transaction | invoice | underwritingFlag | payment | quoteGroup | inquiry
qualification map<string,string>?
DataTypeRef
required
data map<string,PropertyRef>

optional
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
availabilityTimeBasis Enum policyStartTime | termStartTime
default: TermStartTime
retirementTimeBasis Enum policyStartTime | termStartTime
default: TermStartTime

optional
availableAfter datetime?
removeOnRenewal boolean?
default: false
removeOnRenewalAfter datetime?
retire boolean?
default: false
retireAfter datetime?
PropertyRef
optional
displayName string?
availability AvailabilityRef?
constraint PropertyConstraint?
defaultValue string?
max string?
maxLength int?
min string?
minLength int?
precision int?
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
column string
table string
where map<string,ConditionValueRef>
ConditionValueRef
required
key string
values string[]
RestrictedDataRef
required
anonymizable boolean
maskingLevel Enum level1 | level2 | none
value Values
Values
required
date string
datetime datetime
decimal number
guid string
int int
long long
string string
ChargeRef
required
category Enum cededPremium | commission | credit | fee | flatCededPremium | flatCommission | flatFee | flatPremium | flatTax | invoiceFee | none | nonFinancial | premium | surcharge | tax
handling Enum flat | normal | retention
invoicing Enum immediate | next | scheduled
transactionBundlingEnabled boolean

optional
displayName string? (deprecated)
BillingPlanRef
required
billingLevel Enum account | inherit | policy
billingTrigger Enum accept | issue (deprecated)

optional
displayName string?
DelinquencyPlanRef
required
gracePeriodDays int

optional
displayName string?
advanceLapseTo Enum? draft | validated | priced | underwritten | accepted | issued
delinquencyLevel Enum? policy | invoice
lapseTransactionType string?
events map<string,DelinquencyEventConfiguration>?
DelinquencyEventConfiguration
required
offsetBasis Enum delinquencyCreation | gracePeriodStart | gracePeriodEnd
offsetDays number
InstallmentPlanRef
required
anchorMode Enum generateDay | termStartDay | dueDay
autopayLeadDays number
cadence Enum none | fullPay | weekly | everyOtherWeek | monthly | quarterly | semiannually | annually | thirtyDays | everyNDays
dueLeadDays int
generateLeadDays int
maxInstallmentsPerTerm int
installmentWeights number[]

optional
displayName string?
InvoicingPlanRef
required
invoiceFeeHandling Enum max | min | sum | waive
invoiceFeeAmounts map<string,number>

optional
displayName string?
AutoRenewalPlanRef
required
generateAutoRenewals boolean

optional
newTermDuration int?
renewalAcceptLeadDays int?
renewalCreateLeadDays int?
renewalIssueLeadDays int?
renewalTransactionType string?
RetryPlanRef
required
attempts int
hoursBetweenAttempts number[]
PaymentRef
required
abstract boolean
defaultSearchable boolean
extend string
numberingPlan string
numberingTrigger Enum creation | validation

optional
displayName string?
data map<string,PropertyRef>?
DisbursementRef
required
data map<string,PropertyRef>

optional
displayName string?
abstract boolean?
extend string?
numberingPlan string?
numberingTrigger Enum? creation | validation
ReversalTypeRef
required
creditType Enum any | creditDistribution | payment
ShortfallTolerancePlanRef
required
currencyTolerances map<string,number>
ExcessCreditPlanRef
required
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 none | pastDueInvoices | allInvoices | invoicesAndUnbilledInstallments
Which pending debits should be considered for determining how much of the credit to retain
negativeInvoiceHandling NegativeInvoiceHandlingRef
disbursementThresholds map<string,number>
NegativeInvoiceHandlingRef
required
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
copyFromQuote boolean
format string
initialCoreNumber string
initialQuoteCoreNumber string
quoteNumberFormat string
termNumberFormat string

optional
displayName string?
productScope string?
RegionRef
optional
displayName string?
numberingString string?
TemplateSnippetConfigRef
required
selectionTimeBasis Enum policyStartTime | termStartTime | transactionEffectiveTime | currentTime

optional
displayName string?
ScheduleRef
required
resetOnRenewal boolean
data map<string,PropertyRef>

optional
displayName string?
abstract boolean?
extend string?
LossRef
required
category string
data map<string,PropertyRef>

optional
abstract boolean?
extend string?
coverageTypes string[]?
ClaimRef
required
claimCategory string

optional
abstract boolean?
extend string?
TableRef
required
selectionTimeBasis Enum policyStartTime | termStartTime | transactionEffectiveTime | currentTime
columns map<string,ColumnRef>
RangeTableRef
required
rangeStart string
selectionTimeBasis Enum policyStartTime | termStartTime | transactionEffectiveTime | currentTime
columns map<string,ColumnRef>

optional
rangeEnd string?
ColumnRef
required
dataType string
isKey boolean
ConstraintTableRef
required
selectionTimeBasis Enum policyStartTime | termStartTime | transactionEffectiveTime | currentTime
columns map<string,ConstraintColumnRef>
ConstraintColumnRef
required
dataType string
makeDistinct boolean
DocumentConfigRef
required
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
customFonts string[]
templateSnippets string[]

optional
displayName string?
margin DocumentMarginRef?
pageSize Enum? letter | legal | A3 | A4 | A5 | B4 | B5
portrait boolean?

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
optional
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
consolidatedDocuments string[]

optional
displayName string?
leadingDocumentTemplate string?
pageNumbering ConsolidatedPageNumberingRef?
ConsolidatedPageNumberingRef
required
enableNumbering boolean
leadingDocumentPages boolean
xPosition int
yPosition int
CustomEventRef
required
type string

optional
schedule EventScheduleRef?
EventScheduleRef
required
anchor Enum policyStart | policyEnd | termStart | segmentStart

optional
alignment Enum? weekStart | monthStart | yearStart
cadence EventCadenceRef?
offset map<string,int>?
suppressOnStatuses Enum[]? pending | expired | cancelled | cancelPending | onRisk | delinquent | doNotRenew
EventCadenceRef
required
durationBasis Enum years | months | weeks | days | hours
intervalDuration int

optional
limit int?
TenantCustomEventRef
required
isPersisted boolean
type string

optional
schedule TenantEventScheduleRef?
TenantEventScheduleRef
optional
alignment Enum? weekStart | monthStart | yearStart
cadence EventCadenceRef?
offset map<string,int>?
SecretRef
required
items map<string,PrimitivePropertyRef>
PrimitivePropertyRef
required
dataType string
AuxDataSettingsRef
required
expirationPeriod int

optional
displayName string?
DataAccessControlRef
required
account DataAccessControlFieldRef
dataMasking boolean
enabled boolean
policy DataAccessControlFieldRef
DataAccessControlFieldRef
required
fields string[]
ContactRef
required
data map<string,PropertyRef>

optional
abstract boolean?
defaultSearchable boolean?
extend string?
AutomationPluginRef
optional
enableWebhooks boolean?
secret string?
webhookHandlerTimeout int?
actions map<string,AutomationPluginActionRef>?
AutomationPluginActionRef
optional
timeout int?
request map<string,PropertyRef>?
response map<string,PropertyRef>?
ProducerManagementRef
required
underwritingFlag UnderwritingFlagRef
producerCodes map<string,ProducerCodeRef>
producers map<string,ProducerRef>
UnderwritingFlagRef
optional
level Enum? info | block | decline | reject | approve
note string?
tag string?
ProducerCodeRef
required
abstract boolean
defaultSearchable boolean
extend string
numberingPlan string
numberingString string

optional
displayName string?
data map<string,PropertyRef>?
ProducerRef
required
abstract boolean
defaultSearchable boolean
extend string

optional
displayName string?
data map<string,PropertyRef>?