Products API

Endpoint Index

Action	Endpoint
Fetch all product configurations in a tenant	GET /products/ GET /products/{configVersion}
Fetch configuration information for policyholders	GET /products/policyholder

Products and Policies

Fetch all product configurations in a tenant¶

GET /products/
GET /products/{configVersion}

Request:

Name	Position	Type	Required
configVersion	path	integer	optional

Response: [ProductConfigurationResponse]

Note

In addition to normal products, a global product will also be returned. This product is used for system purposes and can generally be disregarded.

ProductConfigurationResponse¶

required
name string
policyConfiguration PolicyConfigurationResponse

optional
claimConfiguration ClaimConfigurationResponse
premiumReportingConfiguration [PremiumReportingConfigurationResponse]
configVersion integer

PolicyConfigurationResponse¶

required
exposures [ExposureConfigurationResponse]
documents [PolicyDocumentConfiguration]
cancellations CancellationConfigurationResponse
endorsements [EndorsementConfigurationResponse]
externalDataCalls [FrontendExternalDataCallConfiguration]
fees [FeeConfigurationResponse]
fields [FieldConfiguration]
invoicing PolicyInvoicingConfiguration
paymentSchedules [PaymentScheduleResponse]
plugins ProductScriptingConfig
reminders [ReminderConfigurationResponse]
renewals [RenewalConfigurationResponse]
taxes [TaxConfigurationResponse]

optional
defaultPaymentTerms PaymentTermsResponse
externalRater string
lapse LapseConfigurationResponse
policyAsOf string quotation | term_start
searchSummary [string]

PolicyDocumentConfiguration¶

required
displayName string
fileName string
generatingEvent string quote | accept | issue
templateName string
type string pdf | html

optional
pageLayout DocumentPageLayout

DocumentPageLayout¶

optional
marginBottom number
marginLeft number
marginRight number
marginTop number
orientation string portrait | landscape
pageSize string letter | legal | tabloid | a3 | a4 | a5 | b4 | b5

PolicyInvoicingConfiguration¶

required
generatingEvent string quote | accept | issue

ExposureConfigurationResponse¶

required
name string
perils [PerilConfigurationResponse]
displayName string
externalDataCalls [FrontendExternalDataCallConfiguration]
fields [FieldConfiguration]

FrontendExternalDataCallConfiguration¶

required
targetFields [string]
triggerField string

FieldConfiguration¶

required
name string
title string
order integer
type string

optional
condition map<string,string>
heading string
optional boolean

Depending on the value of the type attribute, this will appear as one of the following subtypes:

DateFieldConfiguration¶

required
name string
title string
order integer
precision string year | month | day | second

optional
condition map<string,string>
heading string
maximum string
maximumOffset DateOffsetConfiguration
minimum string
minimumOffset DateOffsetConfiguration
newline boolean
optional boolean
showCalendar boolean
width integer

DateOffsetConfiguration¶

required
amount integer
field string year | month | day | second

optional
roundToDay boolean

EmailFieldConfiguration¶

required
name string
title string
order integer

optional
condition map<string,string>
heading string
newline boolean
optional boolean
search string
width integer

GroupFieldConfiguration¶

required
name string
title string
fields [FieldConfiguration]
order integer

optional
condition map<string,string>
heading string
maximum integer
newline boolean
optional boolean
repeatable boolean
width integer

LookupFieldConfiguration¶

required
name string
title string
order integer
table string

optional
condition map<string,string>
heading string
match [string]
newline boolean
optional boolean
public boolean
width integer

MediaFieldConfiguration¶

required
name string
title string
order integer

optional
condition map<string,string>
heading string
newline boolean
optional boolean
repeatable boolean
width integer

NumberFieldConfiguration¶

required
name string
title string
order integer

optional
maximum number
minimum number
condition map<string,string>
decimalPlaces integer
heading string
newline boolean
optional boolean
width integer

SelectFieldConfiguration¶

required
name string
title string
order integer
values [string]

optional
condition map<string,string>
heading string
newline boolean
optional boolean
repeatable boolean
search string
width integer

StringFieldConfiguration¶

required
name string
title string
order integer

optional
condition map<string,string>
heading string
maximum integer
multiline boolean
newline boolean
optional boolean
regex string
search string
width integer

PerilConfigurationResponse¶

required
name string
displayName string
externalDataCalls [FrontendExternalDataCallConfiguration]
fields [FieldConfiguration]

optional
deductible number
lumpSumPayment number
indemnityInAggregate string
indemnityPerEvent string
indemnityPerItem string

TaxConfigurationResponse¶

required
name string
displayName string

FeeConfigurationResponse¶

required
name string
displayName string

EndorsementConfigurationResponse¶

required
name string
documents [PolicyDocumentConfiguration]
displayName string
reprice string always | never | input | all

RenewalConfigurationResponse¶

required
documents [PolicyDocumentConfiguration]

optional
renewalAsOf string quotation | term_start

PaymentTermsResponse¶

required
amount integer
unit string day

PaymentScheduleResponse¶

required
name string
displayName string
type string total | custom | monthly | annually | semiannually | quarterly | every_two_weeks | every_week | 2Pay | 5Pay

CancellationConfigurationResponse¶

optional
reasons [CancellationReasonConfigurationResponse]

CancellationReasonConfigurationResponse¶

required
name string
title string
documents [PolicyDocumentConfiguration]

optional
cancellationCategories [string]
reinstatement ReinstatementConfigurationResponse

ReinstatementConfigurationResponse¶

required
documents [PolicyDocumentConfiguration]

optional
defaultDeadlineDays integer

LapseConfigurationResponse¶

required
gracePeriodDays integer
reinstatementPeriodDays integer

PremiumReportingConfigurationResponse¶

required
id string
documents [PolicyDocumentConfiguration]
fields [FieldConfiguration]
productRevisionLocator string
reportName string
tenantLocator string

optional
searchSummary [string]

ClaimConfigurationResponse¶

required
fields [FieldConfiguration]

optional
searchSummary [string]
subClaimConfiguration SubClaimConfigurationResponse

SubClaimConfigurationResponse¶

required
fields [FieldConfiguration]

optional
searchSummary [string]

ReminderConfigurationResponse¶

required
name string
enabled boolean
from string policy.end
offset string

ProductScriptingConfig¶

required
createInstallments ProductPluginConfig
getDataAutofill ProductPluginConfig
getPerilRates ProductPluginConfig
getPostIssuanceResult ProductPluginConfig
getPostPaymentReversal ProductPluginConfig
getPreGraceResult ProductPluginConfig
getProrationResult ProductPluginConfig
getUnderwritingResult ProductPluginConfig

ProductPluginConfig¶

required
enabled boolean
path string
type string echo | rater | underwriter | prorater | installments | postIssuance | postPaymentReversal | preGrace | dataAutofill

ReminderOffset

These strings indicate a fixed duration of time using a subset of the ISO-8601 date format.

Examples of valid offsets are: "-1d" or "-7d" or "-30d" (for one/seven/thirty days before)

Such durations are subtracted from the occurrence described in the reminder’s "from" property.

For example, a reminder "-7d" from "policy.end" will fire one week before the policy ends.

Policyholders

Fetch configuration information for policyholders¶

GET /products/policyholder

Response: PolicyholderConfigurationResponse

PolicyholderConfigurationResponse¶

required
fields [FieldConfiguration]

Note

There are some aspects of policyholder configuration that are not included in the response from the Products API. This endpoint is intended to provide information about field definitions. Some properties have been changed or omitted to conform with the FieldConfiguration object used in the main products API:

prompt is returned in the property title.
section.title is returned in the property heading.
visibleIf is not included.