Quotes API

Endpoint Index

ActionEndpoint
Fetch a QuoteGET /policy/{tenantLocator}/quotes/{locator}
Fetch All QuotesGET /policy/{tenantLocator}/quotes/list
Create a QuotePOST /policy/{tenantLocator}/quotes
Update a QuotePATCH /policy/{tenantLocator}/quotes/{locator}
Add Elements to a QuotePUT /policy/{tenantLocator}/quotes/{locator}/elements
Remove Elements from a QuoteDELETE /policy/{tenantLocator}/quotes/{locator}/elements
Validate a QuotePATCH /policy/{tenantLocator}/quotes/{locator}/validate
Price a QuotePATCH /policy/{tenantLocator}/quotes/{locator}/price
Fetch Quote PricingGET /policy/{tenantLocator}/quotes/{locator}/price
Underwrite a QuotePATCH /policy/{tenantLocator}/quotes/{locator}/underwrite
Fetch Underwriting FlagsGET /policy/{tenantLocator}/quotes/{locator}/underwritingFlags
Update a Quote's Underwriting FlagsPATCH /policy/{tenantLocator}/quotes/{locator}/underwritingFlags
Accept a QuotePATCH /policy/{tenantLocator}/quotes/{locator}/accept
Issue a QuotePATCH /policy/{tenantLocator}/quotes/{locator}/issue
Copy a QuotePOST /policy/{tenantLocator}/quotes/{locator}/copy
Assign Quote GroupPATCH /policy/{tenantLocator}/quotes/{locator}/assignToGroup
Fetch All Quotes In GroupGET /policy/{tenantLocator}/quotes/group/{locator}/list
Add Static Data to a QuotePOST /policy/{tenantLocator}/quotes/{locator}/static
Update Static Data on a QuotePATCH /policy/{tenantLocator}/quotes/{locator}/static
Replace All Static Data on a QuotePUT /policy/{tenantLocator}/quotes/{locator}/static
Update Billing Level for a QuotePATCH /policy/{tenantLocator}/quotes/{locator}/billingLevel
Fetch Quotes with NumberGET /policy/{tenantLocator}/quotes/numbers/{quoteNumber}
Set Quote NumberPOST /policy/{tenantLocator}/quotes/{locator}/number/set
Reset a QuotePATCH /policy/{tenantLocator}/quotes/{locator}/reset
Refuse a Quote (Insured Declined Coverage)PATCH /policy/{tenantLocator}/quotes/{locator}/refuse
Discard a QuotePATCH /policy/{tenantLocator}/quotes/{locator}/discard

Main Flow

Fetch

Fetch a Quote
fetchQuote
GET /policy/{tenantLocator}/quotes/{locator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Response:QuoteResponse
    Security Group:quotes   Permission:read
Fetch All Quotes
Deprecated
fetchQuotesInATenant
This endpoint will be removed in a future release.
GET /policy/{tenantLocator}/quotes/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?optional
    Security Group:quotes   Permissions:read,list
Fetch All Quotes for an Account
fetchQuotesForAccount
GET /policy/{tenantLocator}/accounts/{locator}/quotes/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    offsetqueryint?optional
    countqueryint?optional
    includeStaticDataqueryboolean?optional
    extendedqueryboolean?optional
    Security Group:accounts   Permissions:read,list
QuoteListResponse
required
listCompleted boolean
items QuoteResponse[]
QuoteResponse
required
locator locator
accountLocator locator
groupLocator locator
productName string
quoteState Enum draft | validated | earlyUnderwritten | priced | underwritten | accepted | issued | underwrittenBlocked | declined | rejected | refused | discarded
billingLevel Enum account | inherit | policy
element ElementResponse
The root element in the hierarchy

optional
policyLocator locator?
quickQuoteLocator locator?
region string?
autoRenewalPlanName string?
delinquencyPlanName string?
issuedTime datetime?
startTime datetime?
endTime datetime?
acceptedTime datetime?
currency string?
duration number?
The duration of the prospective policy in units of durationBasis
durationBasis Enum? years | months | weeks | days | hours
timezone string?
expirationTime datetime?
policyNumber string?
preferences PreferencesResponse?
Plan selections and setting overrides
quoteNumber string?
underwritingStatus string?
validationResult ValidationResult?
static map<string,object>?
billingTrigger Enum? accept | issue (deprecated)

Note

The properties accountLocator, productName, startTime, endTime, duration, durationBasis, currency, element, expirationTime, and timezone will all be non-null for quotes that have been validated.

ElementResponse
required
locator locator
staticLocator locator
parentLocator locator
originalEffectiveTime datetime
Indicates when the element was first added to the policy
type string

optional
category Enum? product | coverage | exposure | exposureGroup | policyLine
data map<string,object>?
coverageTerms map<string,string>?
elements ElementResponse[]?
PreferencesResponse
optional
billingPreferences BillingPreferences?
installmentPreferences InstallmentPreferences?
BillingPreferences
optional
billingPlanName string?
billingLevel Enum? account | inherit | policy
InstallmentPreferences
required
installmentWeights number[]

optional
installmentPlanName string?
anchorMode Enum? generateDay | termStartDay | dueDay
anchorTime datetime?
anchorType Enum? none | dayOfMonth | anchorTime | dayOfWeek | weekOfMonth
cadence Enum? none | fullPay | weekly | everyOtherWeek | monthly | quarterly | semiannually | annually | thirtyDays | everyNDays
dayOfMonth int?
dayOfWeek Enum? monday | tuesday | wednesday | thursday | friday | saturday | sunday
dueLeadDays int?
generateLeadDays int?
maxInstallmentsPerTerm int?
weekOfMonth Enum? none | first | second | third | fourth | fifth

Quote Creation

Create a Quote
createQuote
POST /policy/{tenantLocator}/quotes
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    Response:QuoteResponse
    Security Group:quotes   Permission:write
QuoteCreateRequest
required
accountLocator locator
productName string
startTime datetime
data map<string,object>

optional
region string?
autoRenewalPlanName string?
delinquencyPlanName string?
endTime datetime?
currency string?
durationBasis Enum? years | months | weeks | days | hours
timezone string?
billingLevel Enum? account | inherit | policy
expirationTime datetime?
preferences PreferencesResponse?
static map<string,object>?
coverageTerms map<string,string>?
billingTrigger Enum? accept | issue (deprecated)
ElementCreateRequest
required
type string

optional
staticLocator locator?
parentLocator locator?
data map<string,object>?
coverageTerms map<string,string>?

Update

Update a Quote
updateQuote
PATCH /policy/{tenantLocator}/quotes/{locator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Response:QuoteResponse
    Security Group:quotes   Permission:write
QuoteUpdateRequest
required
autoRenewalPlanName string
delinquencyPlanName string
startTime datetime
endTime datetime
currency string
billingLevel Enum account | inherit | policy
expirationTime datetime
preferences PreferencesResponse
removeCoverageTerms map<string,object>
removeData map<string,object>
setCoverageTerms map<string,string>
setData map<string,object>
billingTrigger Enum accept | issue (deprecated)
ElementUpdateRequest
required
locator locator
removeCoverageTerms map<string,object>
removeData map<string,object>
setCoverageTerms map<string,string>
setData map<string,object>
Add Elements to a Quote
addElementsToQuote
PUT /policy/{tenantLocator}/quotes/{locator}/elements
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Response:QuoteResponse
    Security Group:quotes   Permission:write
Remove Elements from a Quote
removeElementsFromQuote
DELETE /policy/{tenantLocator}/quotes/{locator}/elements
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Request:locator[]
    Response:QuoteResponse
    Security Group:quotes   Permission:write

Validation

Validate a Quote
validateQuote
PATCH /policy/{tenantLocator}/quotes/{locator}/validate
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    statelessqueryboolean?optional
    Response:QuoteResponse
    Security Group:quotes   Permission:write
ValidationResult
required
success boolean

optional
validationItems ValidationItemResponse[]?
ValidationItemResponse
required
locator locator
elementType string
errors string[]

Pricing

Price a Quote
priceQuote
PATCH /policy/{tenantLocator}/quotes/{locator}/price
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    statelessqueryboolean?optional
    Security Group:quotes   Permission:write
Fetch Quote Pricing
fetchPricedQuote
GET /policy/{tenantLocator}/quotes/{locator}/price
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Security Group:quotes   Permission:read
QuotePriceResponse
required
accountLocator locator
quoteLocator locator
tenantLocator uuid
productName string
startTime datetime
endTime datetime
duration number
durationBasis Enum years | months | weeks | days | hours
quoteState Enum draft | validated | earlyUnderwritten | priced | underwritten | accepted | issued | underwrittenBlocked | declined | rejected | refused | discarded

optional
quoteNumber string?
ChargeResponse
required
locator locator
elementLocator locator
elementStaticLocator locator
amount number
chargeCategory Enum premium | tax | fee | credit | nonFinancial | surcharge
chargeType string
rate number
referenceRate number

optional
reversalOfLocator locator?
rateDifference number?
tag string?

Underwriting

Underwrite a Quote
underwriteQuote
PATCH /policy/{tenantLocator}/quotes/{locator}/underwrite
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    statelessqueryboolean?optional
    Security Group:quotes   Permission:write
QuoteUnderwritingResponse
required
accountLocator locator
quoteLocator locator
tenantLocator uuid
productName string
startTime datetime
endTime datetime
duration number
durationBasis Enum years | months | weeks | days | hours
quoteState Enum draft | validated | earlyUnderwritten | priced | underwritten | accepted | issued | underwrittenBlocked | declined | rejected | refused | discarded
underwritingStatus string
underwritingFlags UnderwritingFlagResponse[]
Fetch Underwriting Flags
fetchUnderwritingFlagsForQuote
GET /policy/{tenantLocator}/quotes/{locator}/underwritingFlags
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Security Group:quotes   Permission:read
QuoteUnderwritingFlagsResponse
required
quoteLocator locator

optional
clearedFlags UnderwritingFlagResponse[]?
UnderwritingFlag
required
locator locator
referenceLocator locator
level Enum info | block | decline | reject | approve
referenceType Enum quote | transaction

optional
elementLocator locator?
clearedAt datetime?
note string?
Update a Quote's Underwriting Flags
updateUnderwritingFlagsForQuote
PATCH /policy/{tenantLocator}/quotes/{locator}/underwritingFlags
UnderwritingFlagsUpdateRequest
required
clearFlags locator[]
UnderwritingFlagCreateRequest
required
elementLocator locator
level Enum info | block | decline | reject | approve
note string

Acceptance

Accept a Quote
acceptQuote
PATCH /policy/{tenantLocator}/quotes/{locator}/accept
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Response:QuoteResponse
    Security Group:quotes   Permission:write

Issuance

Issue a Quote
issueQuote
PATCH /policy/{tenantLocator}/quotes/{locator}/issue
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Response:QuoteResponse
    Security Group:quotes   Permission:write

Quote Copy and Group Assignment

Copy a Quote
copyQuote
POST /policy/{tenantLocator}/quotes/{locator}/copy
Assign Quote Group
assignQuoteGroup
PATCH /policy/{tenantLocator}/quotes/{locator}/assignToGroup
QuoteGroupAssignmentRequest
required
groupLocator locator
Fetch All Quotes In Group
fetchAllQuotesInGroup
GET /policy/{tenantLocator}/quotes/group/{locator}/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?optional
    Security Group:quotes   Permissions:read,list

Static Data

Add Static Data to a Quote
addStaticDataForQuote
Set the static extension data on a quote
POST /policy/{tenantLocator}/quotes/{locator}/static
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Request:map<string,object>
    Response:QuoteResponse
    Security Group:quotes   Permission:write
Update Static Data on a Quote
updateStaticDataForQuote
Updates some of the static data on a quote
PATCH /policy/{tenantLocator}/quotes/{locator}/static
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Response:QuoteResponse
    Security Group:quotes   Permission:write
StaticDataUpdateRequest
required
removeData map<string,object>
setData map<string,object>
Replace All Static Data on a Quote
replaceAllStaticDataForQuote
Replaces all of the static data on a quote
PUT /policy/{tenantLocator}/quotes/{locator}/static
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Request:map<string,object>
    Response:QuoteResponse
    Security Group:quotes   Permission:write

Documents

Fetch Documents for a Quote
fetchDocumentsForQuote
GET /document/{tenantLocator}/documents/quote/{locator}/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?optional
    Security Group:documents   Permission:read
DocumentInstanceResponse
required
locator locator
referenceLocator locator
documentInstanceState Enum draft | dataReady | ready | dataError | renderError | conversionError
external boolean
referenceType Enum quote | policy | invoice | transaction | segment | term
createdAt datetime
metadata map<string,object>
renderingData map<string,object>

optional
policyLocator locator?
termLocator locator?
transactionLocator locator?
segmentLocator locator?
referenceDocumentLocator locator?
staticName string?
name string?
category string?
documentFormat Enum? text | html | pdf | jpg | jpeg | doc | docx | xls | xlsx | csv | txt | zip
processingErrors string?
readyAt datetime?
createdBy uuid?

Billing

Update Billing Level for a Quote
updateBillingLevelForAQuote
PATCH /policy/{tenantLocator}/quotes/{locator}/billingLevel
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Response:QuoteResponse
    Security Group:quotes   Permission:write
UpdateBillingLevelRequest
required
billingLevel Enum account | inherit | policy
Update the Delinquency Plan Assigned to a Quote
updateQuoteDelinquencyPlan
PATCH /policy/{tenantLocator}/quotes/{locator}/delinquencyPlan

Numbering

Fetch Quotes with Number
fetchQuotesWithNumber
GET /policy/{tenantLocator}/quotes/numbers/{quoteNumber}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    quoteNumberpathstringrequired
    Response:QuoteResponse[]
    Security Group:quotes   Permissions:read,list
Set Quote Number
setQuoteNumber
POST /policy/{tenantLocator}/quotes/{locator}/number/set
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    quoteNumberquerystringrequired
    Response:QuoteResponse
    Security Group:quotes   Permission:write

Atypical States and Operations

Reset a Quote
resetQuote
PATCH /policy/{tenantLocator}/quotes/{locator}/reset
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Request:ResetOptions
    Response:QuoteResponse
    Security Group:quotes   Permission:write
ResetOptions
required
deleteAllAutomaticDocuments boolean
resetAllUnderwritingFlags boolean
resetFlagsAction Enum clear | delete
deleteDocuments locator[]
resetFlags locator[]
Refuse a Quote (Insured Declined Coverage)
refuseQuote
PATCH /policy/{tenantLocator}/quotes/{locator}/refuse
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Response:QuoteResponse
    Security Group:quotes   Permission:write
Discard a Quote
discardQuote
PATCH /policy/{tenantLocator}/quotes/{locator}/discard
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Response:QuoteResponse
    Security Group:quotes   Permission:write