Configuration Deployments API
Tenant Creation
POST /config/createTenant
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
name | query | string? | optional |
description | query | string? | optional |
Request with application/zip:ConfigurationRef
Request with multipart/form-data:ConfigurationRef
Response:TenantDeploymentResult
Security Group:tenants  Permission:create-tenant
TenantDeploymentResult
¶requiredlocator uuidname stringbootstrapResult BootstrapResultdeploymentResult ConfigBuilderResult
Fetch
GET /config/{tenantLocator}/deployments/download
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
Response:StreamingResponseBody<ZipFile>
Security Group:deployments  Permission:deploy
GET /config/{tenantLocator}/deployments/download/{version}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
version | path | string | required |
Response:StreamingResponseBody<ZipFile>
Security Group:deployments  Permission:deploy
GET /config/{tenantLocator}/deployments/datamodel
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
resolve | query | boolean? | optional |
Response:ConfigurationRef
Security Group:deployments  Permission:deploy
GET /config/{tenantLocator}/deployments/datamodel/{version}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
version | path | string | required |
resolve | query | boolean? | optional |
Response:ConfigurationRef
Security Group:deployments  Permission:deploy
GET /config/{tenantLocator}/deployments
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
Response:DeployedConfigMetadata
Security Group:deployments  Permission:read
DeployedConfigMetadata
¶requiredmetadata DeploymentMetadatapluginVersionStatus map<string,map<string,string>>
Redeployment
POST /config/{tenantLocator}/deployments/deploy
Request Parameters:
Name | Position | Type | Required | Default Value |
---|---|---|---|---|
tenantLocator | path | uuid | required | |
overwrite | query | boolean? | optional | False |
Request with application/zip:ConfigurationRef
Request with multipart/form-data:ConfigurationRef
Response:TenantDeploymentResult
Security Group:deployments  Permission:deploy
GET /config/{tenantLocator}/deployments/diff
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
config | query | ConfigurationRef | required |
Response:map<string,MapDifferenceObject>
Security Group:deployments  Permission:deploy
MapDifferenceObject
¶requiredadded map<string,object>modified map<string,object>removed map<string,object>
Validation
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
POST /config/{tenantLocator}/deployments/validate
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
Request with application/zip:ConfigurationRef
Request with multipart/form-data:ConfigurationRef
Response:StreamingResponseBody<ZipFile>
Security Group:deployments  Permission:deploy
Utility
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
¶requiredbootstrap BootstrapRefdataAccessControl DataAccessControlRefdefaultAutoRenewalPlan stringdefaultAuxDataSettings stringdefaultBackdatedInstallmentsBilling Enum immediate | deferDueDatedefaultCurrency stringdefaultDelinquencyPlan stringdefaultDurationBasis Enum years | months | weeks | days | hoursdefaultExcessCreditPlan stringdefaultInstallmentPlan stringdefaultInvoiceDocument stringdefaultSearchable booleandefaultShortfallTolerancePlan stringdefaultTermDuration numberdefaultTimeZone stringworkManagement WorkManagementRefaccounts 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)optionaldefaultBillingTrigger Enum? accept | issue (deprecated)defaultRegion string? (deprecated)
BootstrapRef
¶requiredresources ResourcesRef
ResourcesRef
¶requiredresourceGroups map<string,ResourceGroupRef>resourceInstances map<string,ResourceInstanceRef>
ResourceInstanceRef
¶requiredstaticName string
ResourceGroupRef
¶requiredselectionStartTime datetimeresourceNames string[]
ConfigBuilderResult
¶requiredisSuccess booleanmetadata DeploymentMetadataerrors string[]
BootstrapResult
¶requirederror stringstatus Enum queued | failed
DeploymentMetadata
¶requiredlatestVersion locatorversion1 locatorversion2 locatorplugins map<string,map<string,string>>
TransactionTypeRef
¶requiredcategory Enum issuance | change | renewal | cancellation | reinstatement | reversal | aggregatecostBearing boolean
AccountRef
¶requiredabstract booleandefaultInvoiceDocument stringdefaultSearchable booleanextend stringinvoiceNumberingPlan stringnumberingPlan stringdata map<string,PropertyRef>optionaldisplayName string?
ProductRef
¶requiredabstract booleandefaultBillingTrigger Enum accept | issuedefaultDurationBasis Enum years | months | weeks | days | hoursdefaultInstallmentPlan stringdefaultSearchable booleandefaultTermDuration numberextend stringdata map<string,PropertyRef>charges string[]contents string[]coverageTerms string[]documents string[]eligibleAccountTypes string[]staticData map<string,PropertyRef>defaultBillingPlan string (deprecated)pluralType string (deprecated)optionaldisplayName string?defaultAutoRenewalPlan string?defaultDelinquencyPlan string?defaultShortfallTolerancePlan string?numberingPlan string?numberingString string?
ElementRef
¶requiredabstract booleandefaultSearchable booleanextend stringcharges string[]contents string[]pluralType string (deprecated)optionaldisplayName string?data map<string,PropertyRef>?coverageTerms string[]?
CoverageTermRef
¶requiredtype Enum splitLimit | deductible | limitoptions map<string,CoverageTermOptionRef>optionaldisplayName string?
CoverageTermOptionRef
¶requiredtag stringvalue numberoptionaldisplayName string?
DataTypeRef
¶requiredabstract booleandefaultSearchable booleanextend stringdata map<string,PropertyRef>optionaldisplayName string?
PropertyRef
¶requiredconstraint PropertyConstraintdefaultValue stringmax stringmaxLength intmin stringminLength intprecision intregex stringroundingMode Enum ceiling | down | floor | halfDown | halfEven | halfUp | upscope stringsearchable booleantype stringoptions string[]tag string[]optionaldisplayName string?
PropertyConstraint
¶requiredcolumn stringtable stringwhere map<string,ConditionValueRef>
ConditionValueRef
¶requiredkey stringvalues string[]
ChargeRef
¶requiredcategory Enum premium | tax | fee | credit | nonFinancial | surchargeoptionaldisplayName string? (deprecated)
BillingPlanRef
¶requiredbillingLevel Enum account | inherit | policybillingTrigger Enum accept | issue (deprecated)optionaldisplayName string?
DelinquencyPlanRef
¶requiredgracePeriodDays intevents map<string,DelinquencyEventConfiguration>optionaldisplayName string?advanceLapseTo Enum? draft | validated | priced | underwritten | accepted | issueddelinquencyLevel Enum? policy | invoicelapseTransactionType string?
DelinquencyEventConfiguration
¶requiredoffsetBasis Enum delinquencyCreation | gracePeriodEndoffsetDays number
InstallmentPlanRef
¶requiredanchorMode Enum generateDay | termStartDay | dueDaycadence Enum none | fullPay | weekly | everyOtherWeek | monthly | quarterly | semiannually | annually | thirtyDays | everyNDaysdueLeadDays intgenerateLeadDays intmaxInstallmentsPerTerm intinstallmentWeights number[]optionaldisplayName string?
AutoRenewalPlanRef
¶requiredgenerateAutoRenewals booleanoptionalnewTermDuration int?renewalAcceptLeadDays int?renewalCreateLeadDays int?renewalIssueLeadDays int?renewalTransactionType string?
PaymentRef
¶requiredabstract booleanextend stringdata map<string,PropertyRef>optionaldisplayName string?
DisbursementRef
¶requiredabstract booleanextend stringnumberingPlan stringdata map<string,PropertyRef>optionaldisplayName string?
ReversalTypeRef
¶requiredcreditType Enum any | creditDistribution | payment
ShortfallTolerancePlanRef
¶requiredcurrencyTolerances map<string,number>
ExcessCreditPlanRef
¶requireddisburseExcess 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 retaindisbursementThresholds map<string,number>
NumberingPlanRef
¶requiredcopyFromQuote booleanformat stringinitialCoreNumber stringinitialQuoteCoreNumber stringquoteNumberFormat stringtermNumberFormat stringoptionaldisplayName string?
RegionRef
¶requirednumberingString stringoptionaldisplayName string?
TableRef
¶requiredselectionTimeBasis Enum policyStartTime | termStartTime | transactionEffectiveTime | currentTimecolumns map<string,ColumnRef>
ConstraintTableRef
¶requiredselectionTimeBasis Enum policyStartTime | termStartTime | transactionEffectiveTime | currentTimecolumns map<string,ConstraintColumnRef>
ColumnRef
¶requireddataType stringisKey boolean
DocumentConfigRef
¶requiredformat Enum text | html | pdf | jpg | jpeg | doc | docx | xls | xlsx | csv | txt | ziprendering Enum dynamic | prerenderedscope Enum transaction | policy | term | segment | invoiceselectionTimeBasis Enum policyStartTime | termStartTime | transactionEffectiveTime | currentTimetrigger Enum validated | priced | accepted | issued | underwritten | generatedoptionaldisplayName string?margin DocumentMarginRef?pageSize Enum? letter | legal | A3 | A4 | A5 | B4 | B5portrait 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
¶optionalbottom number?left number?right number?top number?
The bottom
, left
, right
and top
properties represent the size of the margin in millimeters.
CustomEventRef
¶requiredtype string
SecretRef
¶requireditems map<string,PrimitivePropertyRef>
PrimitivePropertyRef
¶requireddataType string
AuxDataSettingsRef
¶requiredexpirationPeriod intoptionaldisplayName string?
DataAccessControlRef
¶requiredaccount DataAccessControlFieldRefenabled booleanpolicy DataAccessControlFieldRef
DataAccessControlFieldRef
¶requiredfields string[]