Calculation API

The calculation API is used for testing rating scenarios, based on either hypothetical peril values with Test Calculate Peril Premium or an existing peril with Test Calculate Premium for an Existing Peril.

Endpoint Index

ActionEndpoint
Test Calculate Peril PremiumPOST /calculation/checkPerilPremium
Test Calculate Premium for an Existing PerilPOST /calculation/checkExistingPerilPremium

Details

Test Calculate Peril Premium
POST /calculation/checkPerilPremium
CheckPerilPremiumRequest
required
productName string
exposureName string
perilName string
calculation string
exposureCharacteristics ExposureCharacteristicsPriceRequest
perilCharacteristics PerilCharacteristicsPriceRequest
policyCharacteristics PolicyCharacteristicsPriceRequest

optional
resourcesAfOfTimestamp timestamp
PolicyCharacteristicsPriceRequest
required
policyEndTimestamp timestamp
policyStartTimestamp timestamp
fieldGroupsByLocator map<string,map<string,[string]>>

optional
fieldValues map<string,[string]>
ExposureCharacteristicsPriceRequest
required
fieldGroupsByLocator map<string,map<string,[string]>>

optional
fieldValues map<string,[string]>
PerilCharacteristicsPriceRequest
required
fieldGroupsByLocator map<string,map<string,[string]>>

optional
fieldValues map<string,[string]>
deductible number
lumpSumPayment number
indemnityInAggregate string
indemnityPerEvent string
indemnityPerItem string
Test Calculate Premium for an Existing Peril
POST /calculation/checkExistingPerilPremium
CheckExistingPerilPremiumRequest
required
calculation string
perilDisplayId string
CalculationResponse
required
premium number
assignedVariables map<string,object>
commissions [CommissionResponse]

optional
technicalPremium number