Policy Finance

Retrieve a billing comparison for a quote or policy event, with before/after premiums, coverage, tax, and fee changes.

Endpoint#

POST https://api.{ENV}.dais.com/ioi/v3/policy/finance

Request#

curl --location --request POST 'https://api.{ENV}.dais.com/ioi/v3/policy/finance' \
--header 'Authorization: Basic <Base64-encoded API key and secret>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "quoteId": "<UUID of the quote request ID>"
}'

Property	Type	Description
`quoteId`	UUID	Quote to evaluate. Takes precedence when both `quoteId` and `eventId` are supplied.
`eventId`	UUID	Policy event from which to resolve the quote when `quoteId` is omitted.
`endorsementConfigId`	UUID	Optional endorsement configuration identifier.

Provide a quoteId or an eventId associated with a quote. A policyId is not a supported request field.

Response#

When a comparison is available, the response contains comparison totals, line items, and before/after policy segments. This abridged example shows totals and line items:

{
  "totalBeforeCoverages": 5250.0,
  "totalBeforeTaxes": 262.5,
  "totalBeforeFees": 50.0,
  "totalAfterCoverages": 5500.0,
  "totalAfterTaxes": 275.0,
  "totalAfterFees": 50.0,
  "totalCoverageChangeAmount": 250.0,
  "totalTaxesChangeAmount": 12.5,
  "totalFeesChangeAmount": 0.0,
  "totalBeforePremium": 5562.5,
  "totalAfterPremium": 5825.0,
  "totalChangeAmount": 262.5,
  "coverages": [
    {
      "label": "<Label>",
      "beforePremium": 5250.0,
      "afterPremium": 5500.0,
      "changeAmount": 250.0
    }
  ],
  "taxes": [
    {
      "label": "<Label>",
      "beforePremium": 262.5,
      "afterPremium": 275.0,
      "changeAmount": 12.5
    }
  ],
  "fees": [
    {
      "label": "<Label>",
      "beforePremium": 50.0,
      "afterPremium": 50.0,
      "changeAmount": 0.0
    }
  ],
  "effectiveDate": "03/01/26",
  "sequenceNumber": 1
}

Response Fields#

Field	Type	Description
`beforeSegments`	array	Policy segments before the change.
`afterSegments`	array	Policy segments after the change.
`totalBeforeCoverages`	number	Coverage total before the change.
`totalBeforeTaxes`	number	Tax total before the change.
`totalBeforeFees`	number	Fee total before the change.
`totalAfterCoverages`	number	Coverage total after the change.
`totalAfterTaxes`	number	Tax total after the change.
`totalAfterFees`	number	Fee total after the change.
`totalCoverageChangeAmount`	number	Change in coverage total.
`totalTaxesChangeAmount`	number	Change in tax total.
`totalFeesChangeAmount`	number	Change in fee total.
`totalBeforePremium`	number	Total premium before the change, rounded to two decimal places.
`totalAfterPremium`	number	Total premium after the change, rounded to two decimal places.
`totalChangeAmount`	number	Total premium change, rounded to two decimal places.
`coverages`	array	Coverage comparison items.
`taxes`	array	Tax comparison items.
`fees`	array	Fee comparison items.
`effectiveDate`	string (date)	Change effective date, formatted as `MM/dd/yy`.
`sequenceNumber`	integer	Event sequence number.

Each item in coverages, taxes, and fees has label (string), beforePremium (number), afterPremium (number), and changeAmount (number).

Policy Segments#

Common fields on each segment in beforeSegments and afterSegments include:

Field	Type	Description
`startDate`, `endDate`	string (date)	Segment boundaries, formatted as `MM/dd/yy`.
`policyEvent`	object	Policy event associated with the segment.
`segmentType`	string	Segment classification.
`fullTermDays`, `totalDays`, `earnedDays`, `unearnedDays`	integer	Term and segment day counts.
`coverages`, `taxes`, `fees`	array	Pricing elements for the segment.
`totalCoverages`, `totalTaxes`, `totalFees`	number	Segment component totals.
`proratedTotal`, `totalPremium`	number	Segment premium totals.
`segmentPremiumChange`	number	Premium change for the segment.
`quoteId`, `eventId`	UUID	Associated quote and event identifiers.