Configuration Deployments API

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
    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   Permission:deploy
Fetch the Configuration Definition for a Version
fetchConfigDefinitionForAVersion
GET /config/{tenantLocator}/deployments/datamodel/{version}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    versionpathstringrequired
    resolvequeryboolean?optional
    Response:ConfigurationRef
    Security Group:deployments   Permission:deploy
Get Configuration Metadata
getDeployedConfigMetadata
GET /config/{tenantLocator}/deployments
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    Response:DeployedConfigMetadata
    Security Group:deployments   Permission:read
DeployedConfigMetadata
required
metadata DeploymentMetadata
pluginVersionStatus map<string,string>

Redeployment

Redeploy a Configuration
deployConfigZip
POST /config/{tenantLocator}/deployments/deploy
    Request Parameters:
    NamePositionTypeRequiredDefault Value
    tenantLocatorpathuuidrequired
    overwritequeryboolean?optionalFalse
    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,MapDifferenceObject>
    Security Group:deployments   Permission:deploy
MapDifferenceObject
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<string>
    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 requrements
POST /config/formatConfig
    Request with application/zip:ConfigurationRef
    Request with multipart/form-data:ConfigurationRef
    Response:StreamingResponseBody<string>
    Security Group:tenants   Permissions:create-tenant,validate-config

Configuration Entities

ConfigurationRef
required
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
defaultSearchable boolean
defaultShortfallTolerancePlan string
defaultTermDuration number
defaultTimeZone string
workManagement WorkManagementRef
accounts map<string,AccountRef>
autoRenewalPlans map<string,AutoRenewalPlanRef>
auxDataSettings map<string,AuxDataSettingsRef>
charges map<string,ChargeRef>
constraintTables map<string,ConstraintTableRef>
coverages map<string,ElementRef>
coverageTerms map<string,CoverageTermRef>
customEvents map<string,CustomEventRef>
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>
installmentPlans map<string,InstallmentPlanRef>
numberingPlans map<string,NumberingPlanRef>
payments map<string,PaymentRef>
policyLines map<string,ElementRef>
products map<string,ProductRef>
regions map<string,RegionRef>
reversalTypes map<string,ReversalTypeRef>
secrets map<string,SecretRef>
shortfallTolerancePlans map<string,ShortfallTolerancePlanRef>
tables map<string,TableRef>
transactionTypes map<string,TransactionTypeRef>
defaultAnchorMode Enum generateDay | termStartDay | dueDay (deprecated)
defaultBillingLevel Enum account | inherit | policy (deprecated)
defaultBillingPlan string (deprecated)
defaultDueLeadDays int (deprecated)
defaultGenerateLeadDays int (deprecated)
defaultLapseType string (deprecated)
billingPlans map<string,BillingPlanRef> (deprecated)

optional
defaultBillingTrigger Enum? accept | issue (deprecated)
defaultRegion string? (deprecated)
BootstrapRef
required
resources ResourcesRef
ResourcesRef
required
resourceGroups map<string,ResourceGroupRef>
resourceInstances map<string,ResourceInstanceRef>
ResourceInstanceRef
required
staticName string
ResourceGroupRef
required
selectionStartTime datetime
resourceNames string[]
ConfigBuilderResult
required
isSuccess boolean
metadata DeploymentMetadata
errors string[]
DeploymentMetadata
required
latestVersion locator
version1 locator
version2 locator
plugins map<string,map<string,string>>
TransactionTypeRef
required
category Enum issuance | change | renewal | cancellation | reinstatement | reversal | aggregate
costBearing boolean
AccountRef
required
abstract boolean
defaultInvoiceDocument string
defaultSearchable boolean
extend string
invoiceNumberingPlan string
numberingPlan string
data map<string,PropertyRef>

optional
displayName string?
ProductRef
required
abstract boolean
defaultBillingTrigger Enum accept | issue
defaultDurationBasis Enum years | months | weeks | days | hours
defaultInstallmentPlan string
defaultSearchable boolean
defaultTermDuration number
extend string
data map<string,PropertyRef>
charges string[]
contents string[]
coverageTerms string[]
documents string[]
eligibleAccountTypes string[]
staticData map<string,PropertyRef>
defaultBillingPlan string (deprecated)
pluralType string (deprecated)

optional
displayName string?
defaultAutoRenewalPlan string?
defaultDelinquencyPlan string?
defaultShortfallTolerancePlan string?
numberingPlan string?
numberingString string?
ElementRef
required
abstract boolean
defaultSearchable boolean
extend string
charges string[]
contents string[]
pluralType string (deprecated)

optional
displayName string?
data map<string,PropertyRef>?
coverageTerms string[]?
CoverageTermRef
required
type Enum splitLimit | deductible | limit
options map<string,CoverageTermOptionRef>

optional
displayName string?
CoverageTermOptionRef
required
tag string
value number

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

optional
displayName string?
PropertyRef
required
constraint PropertyConstraint
defaultValue string
max string
maxLength int
min string
minLength int
precision int
regex string
roundingMode Enum ceiling | down | floor | halfDown | halfEven | halfUp | up
scope string
searchable boolean
type string
options string[]
tag string[]

optional
displayName string?
PropertyConstraint
required
column string
table string
where map<string,ConditionValueRef>
ConditionValueRef
required
key string
values string[]
ChargeRef
required
category Enum premium | tax | fee | credit | nonFinancial | surcharge

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

optional
displayName string?
DelinquencyPlanRef
required
gracePeriodDays int
events map<string,DelinquencyEventConfiguration>

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

optional
displayName string?
AutoRenewalPlanRef
required
generateAutoRenewals boolean

optional
newTermDuration int?
renewalAcceptLeadDays int?
renewalCreateLeadDays int?
renewalIssueLeadDays int?
renewalTransactionType string?
PaymentRef
required
abstract boolean
extend string
data map<string,PropertyRef>

optional
displayName string?
DisbursementRef
required
abstract boolean
extend string
numberingPlan string
data map<string,PropertyRef>

optional
displayName string?
ReversalTypeRef
required
creditType Enum any | creditDistribution | payment
ShortfallTolerancePlanRef
required
currencyTolerances map<string,number>
ExcessCreditPlanRef
required
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
disbursementThresholds map<string,number>
RegionRef
required
numberingString string

optional
displayName string?
TableRef
required
selectionTimeBasis Enum policyStartTime | termStartTime | transactionEffectiveTime | currentTime
columns map<string,ColumnRef>
ConstraintTableRef
required
selectionTimeBasis Enum policyStartTime | termStartTime | transactionEffectiveTime | currentTime
columns map<string,PrimitivePropertyRef>
ColumnRef
required
dataType string
isKey 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 | issued | underwritten | generated

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.

CustomEventRef
required
type string
SecretRef
required
items map<string,PrimitivePropertyRef>
PrimitivePropertyRef
required
dataType string
AuxDataSettingsRef
required
expirationPeriod int

optional
displayName string?