MarineCargoQuotationDto

Get policy quote for marine policy. This endpoint allows you to add marine policy quote.

POST /api/v1/get-quote

Path param

authorization : *bearer
REQUEST BODY SCHEMA: application/json

---

Name	Description	Required	Type
assets	Cargo assets	Required	Array of Objects
coverType	Recommended if policy has a coverType. It must provided in additional to policyType, otherwise quotation results might be wrong because wrong products will be queried	Not Required	string
policyType	Type of policy. Enum: "AUTO" "BANKERS_INDEMNITY" "BLANKET_BOND" "BONDS" "BOILER_OR_PRESSURE_VESSEL" "BURGLARY" "BUSINESS_INTERRUPTION"	Not Required	string
currency	Policy currency code. Refer to/currencies for available currencies. Enum: "GHS" "GBP" "USD" "EUR"	Required	string
endDate	Policy end date in iso8601 format	Required	string
productId	To get quotation for a single known product, provide the productId. If neither productIds or productId is not provided, the product will be selected based on the policyType and or coverType	Not Required	string
productIds	List of product ids. Selected products MUST have the same category & subcategory. If productIds are not provided, the product will be selected based on the productCategory and or productSubcategory	Not Required	Array of strings
startDate	Policy start date in iso8601 format	Required	string
fleetDiscountRate	Fleets discount rate. Default: 0	Not Required	object
exchangeRate	Current exchange rate. Default: 1	Not Required	number

Response

Code	Description
200	Quote details
409	Unauthorized

Request Sample

Content type
application/json
Example: ProfessionalIndemnityQuotationDto
[
   {
        "currency": "GHC",
        "startDate": "2020-01-01T00:00:00.000Z",
        "endDate": "2020-12-01T00:00:00.000Z",
        "exchangeRate": 1,
        "productIds": [
             "619c0911b46b424f5f3e470f"
        ],
        "productId": "619c0911b46b424f5f3e470f",
        "policyType": "AUTO",
        "coverType": "COMPREHENSIVE",
        "assets": [
            + { .. }
        ]
    }
    ...
]

Response Sample

Content type
application/json
Example: MarineCargoQuotationRespDto
[
    {
        "summary": {
            "premium": 0,
            "stickerFee": 0,
            "commercialLevy": 0,
            "basicPremium": 0,
            "basicRate": 0
        },
        "product": {
            "name": "Motor Insurance",
            "code": "CLAGC",
            "description": "lorem ipsum dolor sit amet",
            "premiumRates": { },
            "category": "AUTO",
            "subCategory": "COMPREHENSIVE",
            "benefits": [],
            "otherCommission": {},
            "status": "ACTIVE",
            "distribution": "OFFLINE",
            "id": "619c0911b46b424f5f3e470f",
            "assignedTo": [],
            "insurer": {},
            "createdAt": "2020-05-05T00:00:00.000Z",
            "assignedAt": "2020-05-05T00:00:00.000Z",
            "updatedAt": "2020-05-05T00:00:00.000Z",
            "createdBy": {},
            "assignedBy": {},
            "standardCommission": {},
            "overriderCommission": {}
        },
        "assets": [ ],
        "policy": {
            "currency": "GHC",
            "startDate": "2020-01-01T00:00:00.000Z",
            "endDate": "2020-12-01T00:00:00.000Z",
            "exchangeRate": 1,
            "productIds": [],
            "productId": "619c0911b46b424f5f3e470f",
            "policyType": "AUTO",
            "coverType": "COMPREHENSIVE",
            "assets": []
        }
    }
    ...
]