Skip to main content
POST
/
policies
/
{policyId}
/
calculate-quote
Calculate policy quote
curl --request POST \
  --url https://api.example.com/policies/{policyId}/calculate-quote \
  --header 'Content-Type: application/json' \
  --data '
{
  "options": [
    {
      "tier": "<string>",
      "excess": "<string>",
      "assetId": "<string>",
      "perils": [
        {
          "id": "<string>",
          "option": "<string>",
          "available": true,
          "unavailabilityMessage": "<string>"
        }
      ]
    }
  ],
  "skipValidation": true,
  "brokerageFeesOverride": [
    {
      "brokerageFirmId": "<string>",
      "fee": 50
    }
  ],
  "customFieldsToOverride": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "assetIds": [
    "<string>"
  ],
  "prorated": true
}
'
{
  "policy": {
    "id": "<string>",
    "entityId": "<string>",
    "provider": {
      "id": "<string>",
      "version": "<string>"
    },
    "rates": [
      {
        "id": "<string>",
        "rate": 123,
        "inputs": [
          {
            "id": "<string>",
            "value": "<string>"
          }
        ]
      }
    ],
    "totalPremium": {
      "amountPreFeesAndTaxes": 123,
      "fees": [
        {
          "id": "<string>",
          "chargeType": "ONE_TIME",
          "amount": 123,
          "brokerageFirmId": "<string>"
        }
      ],
      "totalFees": 123,
      "amountWithFeesPreTaxes": 123,
      "taxes": [
        {
          "id": "<string>",
          "chargeType": "ONE_TIME",
          "amount": 123
        }
      ],
      "totalTaxes": 123,
      "amountWithFeesAndTaxes": 123
    },
    "components": [
      {
        "id": "<string>",
        "type": "PREMIUM",
        "premium": {
          "amountPreFeesAndTaxes": 123,
          "fees": [
            {
              "id": "<string>",
              "chargeType": "ONE_TIME",
              "amount": 123,
              "brokerageFirmId": "<string>"
            }
          ],
          "totalFees": 123,
          "amountWithFeesPreTaxes": 123,
          "taxes": [
            {
              "id": "<string>",
              "chargeType": "ONE_TIME",
              "amount": 123
            }
          ],
          "totalTaxes": 123,
          "amountWithFeesAndTaxes": 123
        },
        "chargeType": "ONE_TIME"
      }
    ],
    "basePrice": 123
  },
  "assets": [
    {
      "id": "<string>",
      "entityId": "<string>",
      "provider": {
        "id": "<string>",
        "version": "<string>"
      },
      "rates": [
        {
          "id": "<string>",
          "rate": 123,
          "inputs": [
            {
              "id": "<string>",
              "value": "<string>"
            }
          ]
        }
      ],
      "totalPremium": {
        "amountPreFeesAndTaxes": 123,
        "fees": [
          {
            "id": "<string>",
            "chargeType": "ONE_TIME",
            "amount": 123,
            "brokerageFirmId": "<string>"
          }
        ],
        "totalFees": 123,
        "amountWithFeesPreTaxes": 123,
        "taxes": [
          {
            "id": "<string>",
            "chargeType": "ONE_TIME",
            "amount": 123
          }
        ],
        "totalTaxes": 123,
        "amountWithFeesAndTaxes": 123
      },
      "components": [
        {
          "id": "<string>",
          "type": "PREMIUM",
          "premium": {
            "amountPreFeesAndTaxes": 123,
            "fees": [
              {
                "id": "<string>",
                "chargeType": "ONE_TIME",
                "amount": 123,
                "brokerageFirmId": "<string>"
              }
            ],
            "totalFees": 123,
            "amountWithFeesPreTaxes": 123,
            "taxes": [
              {
                "id": "<string>",
                "chargeType": "ONE_TIME",
                "amount": 123
              }
            ],
            "totalTaxes": 123,
            "amountWithFeesAndTaxes": 123
          },
          "chargeType": "ONE_TIME"
        }
      ],
      "options": {
        "tier": "<string>",
        "excess": "<string>",
        "assetId": "<string>",
        "perils": [
          {
            "id": "<string>",
            "option": "<string>",
            "available": true,
            "unavailabilityMessage": "<string>"
          }
        ],
        "brokerageFees": [
          {
            "brokerageFirmId": "<string>",
            "fee": 50
          }
        ]
      },
      "basePrice": 123
    }
  ]
}

Path Parameters

​
policyId
string
required

the policy id

Query Parameters

​
whenAt
string

Optional: the whenAt datetime

​
simulatedAt
string

Optional: the simulatedAt datetime

​
branchId
string

Optional: the branchId

Body

application/json
​
options
object[]
​
additionalQuoteComponentsAndPercentages
object

Additional quote components and percentages

​
skipValidation
boolean

Debug: force a quote to happen even if there are no changes to quote

​
brokerageFeesOverride
object[]

Brokerage fees to calculate quote with

​
periodDurationOverride
object

Policy period duration value to calculate quote with

​
customFieldsToOverride
object[]

Custom fields you want to calculate quote with

​
assetIds
string[]

The assets ids to quote

​
prorated
boolean

Decide if the quote should be prorated according to the invoicing frequency

Response

​
policy
object
​
assets
object[]