Products API¶
Fetch all products for a tenant¶
GET /products/["/{configVersion}" | ""]
Request:
Name
Position
Type
Required
configVersion
path
integer
optional
Response:
[ProductConfiguration2Response]
ProductConfiguration2Response¶
{// Requiredname : stringpolicyConfiguration : PolicyConfigurationResponse// OptionalclaimConfiguration : ClaimConfigurationResponseconfigVersion : integerpremiumReportingConfiguration : [PremiumReportingConfigurationResponse]}
PolicyConfigurationResponse¶
{// Requiredcancellations : CancellationConfigurationResponsedocuments : [PolicyDocumentConfiguration]endorsements : [EndorsementConfigurationResponse]exposures : [ExposureConfigurationResponse]externalDataCalls : [FrontendExternalDataCallConfiguration]fees : [FeeConfigurationResponse]fields : [FieldConfiguration]invoicing : PolicyInvoicingConfigurationpaymentSchedules : [PaymentScheduleResponse]reminders : [ReminderConfigurationResponse]renewals : [RenewalConfigurationResponse]taxes : [TaxConfigurationResponse]// OptionaldefaultPaymentTerms : PaymentTermsResponseexternalRater : stringlapse : LapseConfigurationResponse}
PolicyDocumentConfiguration¶
{// RequireddisplayName : stringfileName : stringgeneratingEvent : string quote | accept | issuetemplateName : stringtype : string pdf | html}
ExposureConfigurationResponse¶
{// RequireddisplayName : stringexternalDataCalls : [FrontendExternalDataCallConfiguration]fields : [FieldConfiguration]name : stringperils : [PerilConfigurationResponse]}
FieldConfiguration¶
{// Requiredname : stringorder : integertitle : stringtype : string// Optionalcondition : map<string,string>heading : stringoptional : boolean}
Depending on the value of the
type
attribute, this will appear as one of the following subtypes:
"date"
: DateFieldConfiguration
"email"
: EmailFieldConfiguration
"group"
: GroupFieldConfiguration
"lookup"
: LookupFieldConfiguration
"media"
: MediaFieldConfiguration
"number"
: NumberFieldConfiguration
"select"
: SelectFieldConfiguration
"string"
: StringFieldConfiguration
DateFieldConfiguration¶
{// Requiredname : stringorder : integerprecision : string year | month | day | secondtitle : string// Optionalcondition : map<string,string>heading : stringmaximum : stringmaximumOffset : DateOffsetConfigurationminimum : stringminimumOffset : DateOffsetConfigurationnewline : booleanoptional : booleanshowCalendar : booleanwidth : integer}
DateOffsetConfiguration¶
{// Requiredamount : integerfield : string year | month | day | second// OptionalroundToDay : boolean}
EmailFieldConfiguration¶
{// Requiredname : stringorder : integertitle : string// Optionalcondition : map<string,string>heading : stringnewline : booleanoptional : booleanwidth : integer}
GroupFieldConfiguration¶
{// Requiredfields : [FieldConfiguration]name : stringorder : integertitle : string// Optionalcondition : map<string,string>heading : stringmaximum : integernewline : booleanoptional : booleanrepeatable : booleanwidth : integer}
LookupFieldConfiguration¶
{// Requiredname : stringorder : integertable : stringtitle : string// Optionalcondition : map<string,string>heading : stringmatch : [string]newline : booleanoptional : booleanpublic : booleanwidth : integer}
MediaFieldConfiguration¶
{// Requiredname : stringorder : integertitle : string// Optionalcondition : map<string,string>heading : stringnewline : booleanoptional : booleanrepeatable : booleanwidth : integer}
NumberFieldConfiguration¶
{// Requiredname : stringorder : integertitle : string// Optionalcondition : map<string,string>decimalPlaces : integerheading : stringmaximum : numberminimum : numbernewline : booleanoptional : booleanwidth : integer}
SelectFieldConfiguration¶
{// Requiredname : stringorder : integertitle : stringvalues : [string]// Optionalcondition : map<string,string>heading : stringnewline : booleanoptional : booleanrepeatable : booleanwidth : integer}
StringFieldConfiguration¶
{// Requiredname : stringorder : integertitle : string// Optionalcondition : map<string,string>heading : stringmaximum : integermultiline : booleannewline : booleanoptional : booleanregex : stringwidth : integer}
PerilConfigurationResponse¶
{// RequireddisplayName : stringexternalDataCalls : [FrontendExternalDataCallConfiguration]fields : [FieldConfiguration]name : string// Optionaldeductible : numberindemnityInAggregate : stringindemnityPerEvent : stringindemnityPerItem : stringlumpSumPayment : number}
EndorsementConfigurationResponse¶
{// RequireddisplayName : stringdocuments : [PolicyDocumentConfiguration]name : stringreprice : string always | never | input | all}
PaymentScheduleResponse¶
{// RequireddisplayName : stringname : stringtype : string total | monthly | annually | semiannually | quarterly | every_two_weeks | every_week}
CancellationConfigurationResponse¶
{// Optionalreasons : [CancellationReasonConfigurationResponse]}
CancellationReasonConfigurationResponse¶
{// Requireddocuments : [PolicyDocumentConfiguration]name : stringtitle : string// Optionalreinstatement : ReinstatementConfigurationResponse}
ReinstatementConfigurationResponse¶
{// Requireddocuments : [PolicyDocumentConfiguration]// OptionaldefaultDeadlineDays : integer}
LapseConfigurationResponse¶
{// RequiredgracePeriodDays : integerreinstatementPeriodDays : integer}
ClaimConfigurationResponse¶
{// Requiredfields : [FieldConfiguration]// OptionalsubClaimConfiguration : SubClaimConfigurationResponse}
ReminderConfigurationResponse¶
{// Requiredenabled : booleanfrom : string policy.endname : stringoffset : string}
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.