Products API
Endpoint Index
| Action | Endpoint |
|---|---|
| Fetch all products for a tenant | GET /products/ GET /products/{configVersion} |
Details
Fetch all products for a tenant¶
GET /products/GET /products/{configVersion}Request:
| Name | Position | Type | Required |
|---|---|---|---|
| configVersion | path | integer | optional |
Response:
[ProductConfigurationResponse]ProductConfigurationResponse¶
requiredname stringpolicyConfiguration PolicyConfigurationResponseoptionalclaimConfiguration ClaimConfigurationResponsepremiumReportingConfiguration [PremiumReportingConfigurationResponse]configVersion integer
PolicyConfigurationResponse¶
requiredexposures [ExposureConfigurationResponse]documents [PolicyDocumentConfiguration]cancellations CancellationConfigurationResponseendorsements [EndorsementConfigurationResponse]externalDataCalls [FrontendExternalDataCallConfiguration]fees [FeeConfigurationResponse]fields [FieldConfiguration]invoicing PolicyInvoicingConfigurationpaymentSchedules [PaymentScheduleResponse]plugins ProductScriptingConfigreminders [ReminderConfigurationResponse]renewals [RenewalConfigurationResponse]taxes [TaxConfigurationResponse]optionaldefaultPaymentTerms PaymentTermsResponseexternalRater string
PolicyDocumentConfiguration¶
requireddisplayName stringfileName stringgeneratingEvent string quote | accept | issuetemplateName stringtype string pdf | html
PolicyInvoicingConfiguration¶
requiredgeneratingEvent string quote | accept | issue
ExposureConfigurationResponse¶
requiredname stringperils [PerilConfigurationResponse]displayName stringexternalDataCalls [FrontendExternalDataCallConfiguration]fields [FieldConfiguration]
FrontendExternalDataCallConfiguration¶
requiredtargetFields [string]triggerField string
FieldConfiguration¶
requiredname stringtitle stringorder integertype stringoptionalcondition 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 stringtitle stringorder integerprecision string year | month | day | secondoptionalcondition map<string,string>heading stringmaximum stringmaximumOffset DateOffsetConfigurationminimum stringminimumOffset DateOffsetConfigurationnewline booleanoptional booleanshowCalendar booleanwidth integer
DateOffsetConfiguration¶
requiredamount integerfield string year | month | day | secondoptionalroundToDay boolean
EmailFieldConfiguration¶
requiredname stringtitle stringorder integeroptionalcondition map<string,string>heading stringnewline booleanoptional booleanwidth integer
GroupFieldConfiguration¶
requiredname stringtitle stringfields [FieldConfiguration]order integeroptionalcondition map<string,string>heading stringmaximum integernewline booleanoptional booleanrepeatable booleanwidth integer
LookupFieldConfiguration¶
requiredname stringtitle stringorder integertable stringoptionalcondition map<string,string>heading stringmatch [string]newline booleanoptional booleanpublic booleanwidth integer
MediaFieldConfiguration¶
requiredname stringtitle stringorder integeroptionalcondition map<string,string>heading stringnewline booleanoptional booleanrepeatable booleanwidth integer
NumberFieldConfiguration¶
requiredname stringtitle stringorder integeroptionalmaximum numberminimum numbercondition map<string,string>decimalPlaces integerheading stringnewline booleanoptional booleanwidth integer
SelectFieldConfiguration¶
requiredname stringtitle stringorder integervalues [string]optionalcondition map<string,string>heading stringnewline booleanoptional booleanrepeatable booleanwidth integer
StringFieldConfiguration¶
requiredname stringtitle stringorder integeroptionalcondition map<string,string>heading stringmaximum integermultiline booleannewline booleanoptional booleanregex stringwidth integer
PerilConfigurationResponse¶
requiredname stringdisplayName stringexternalDataCalls [FrontendExternalDataCallConfiguration]fields [FieldConfiguration]optionaldeductible numberlumpSumPayment numberindemnityInAggregate stringindemnityPerEvent stringindemnityPerItem string
TaxConfigurationResponse¶
requiredname stringdisplayName string
FeeConfigurationResponse¶
requiredname stringdisplayName string
EndorsementConfigurationResponse¶
requiredname stringdocuments [PolicyDocumentConfiguration]displayName stringreprice string always | never | input | all
RenewalConfigurationResponse¶
requireddocuments [PolicyDocumentConfiguration]
PaymentTermsResponse¶
requiredamount integerunit string day
PaymentScheduleResponse¶
requiredname stringdisplayName stringtype string total | custom | monthly | annually | semiannually | quarterly | every_two_weeks | every_week | 2Pay | 5Pay
CancellationConfigurationResponse¶
optionalreasons [CancellationReasonConfigurationResponse]
CancellationReasonConfigurationResponse¶
requiredname stringtitle stringdocuments [PolicyDocumentConfiguration]optionalcancellationCategories [string]reinstatement ReinstatementConfigurationResponse
ReinstatementConfigurationResponse¶
requireddocuments [PolicyDocumentConfiguration]optionaldefaultDeadlineDays integer
LapseConfigurationResponse¶
requiredgracePeriodDays integerreinstatementPeriodDays integer
PremiumReportingConfigurationResponse¶
requiredid stringdocuments [PolicyDocumentConfiguration]fields [FieldConfiguration]premiumReportingCalculationRevision stringproductRevisionLocator stringreportName stringtenantLocator string
ClaimConfigurationResponse¶
requiredfields [FieldConfiguration]optionalsubClaimConfiguration SubClaimConfigurationResponse
SubClaimConfigurationResponse¶
requiredfields [FieldConfiguration]
ReminderConfigurationResponse¶
requiredname stringenabled booleanfrom string policy.endoffset string
ProductScriptingConfig¶
requiredcreateInstallments ProductPluginConfiggetOnIssuePostProcessorResult ProductPluginConfiggetPerilRates ProductPluginConfiggetProrationResult ProductPluginConfiggetUnderwritingResult ProductPluginConfig
ProductPluginConfig¶
requiredenabled booleanpath stringtype string echo | rater | underwriter | prorater | installments | postprocessor
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.