Quotes API

Tip

See the Quotes feature topic for more information about quotes.

Endpoint Index

Action	Endpoint
Fetch all quotes for a policy	GET /policies/{policyLocator}/quotes
Fetch a quote	GET /quotes/{quoteLocator}
Update a draft quote	PATCH /quotes/{quoteLocator}
Create a new quote using an existing quote	POST /quotes/{quoteLocator}/createNew
Select a quote	PATCH /quotes/{quoteLocator}/select
Price a quote and lock in details	PATCH /quotes/{quoteLocator}/quote
Fetch pricing for a quote that has already been quoted	GET /quotes/{quoteLocator}/price
Accept a quote	PATCH /quotes/{quoteLocator}/accept
Invalidate a previously accepted quote	PATCH /quotes/{quoteLocator}/invalidate
Discard a quote	PATCH /quotes/{quoteLocator}/discard

Details

Fetch all quotes for a policy¶

GET /policies/{policyLocator}/quotes

Request:

Name	Position	Type	Required
policyLocator	path	string	required

Response: [PolicyQuoteResponse]

PolicyQuoteResponse¶

required
locator string
name string
policyholderLocator string
policyLocator string
productLocator string
productName string
state string draft | quoted | accepted | declined | discarded
selected boolean
createdTimestamp timestamp
updatedTimestamp timestamp
contractStartTimestamp timestamp
contractEndTimestamp timestamp
characteristics PolicyCharacteristicsResponse
exposures [ExposureResponse]
documents [PolicyDocumentResponse]
invoices [PolicyQuoteInvoiceResponse]
fees [FeeResponse]

optional
issuedTimestamp timestamp
overrideResourcesAsOfTimestamp timestamp
resourcesAsOfTimestamp timestamp
grossFees number
automatedUnderwritingResult AutomatedUnderwritingResultResponse
grossFeesCurrency string
paymentScheduleName string

Fetch a quote¶

GET /quotes/{quoteLocator}

Request:

Name	Position	Type	Required
quoteLocator	path	string	required

Response: PolicyQuoteResponse

PolicyQuoteInvoiceResponse¶

required
issueTimestamp timestamp
startTimestamp timestamp
endTimestamp timestamp
financialTransactions [FinancialTransactionResponse]

optional
dueTimestamp timestamp

Update a draft quote¶

PATCH /quotes/{quoteLocator}

Request:

Name	Position	Type	Required
quoteLocator	path	string	required
updateRequest	body	PolicyQuoteUpdateRequest	required

Response: PolicyQuoteResponse

PolicyQuoteUpdateRequest¶

optional
name string
overrideResourcesAsOfTimestamp timestamp
policyEndTimestamp timestamp
policyStartTimestamp timestamp
fieldValues map<string,[string]>
addFieldGroups [FieldGroupCreateRequest]
updateFieldGroups [FieldGroupUpdateRequest]
removeFieldGroups [string]
addExposures [ExposureCreateRequest]
updateExposures [DraftPolicyExposureUpdateRequest]
autofill [string]
paymentScheduleName string
removeExposures [string]
resetOverrideResourcesAsOfTimestamp boolean

Note

At least one property is required to be set on the PolicyQuoteUpdateRequest

Create a new quote using an existing quote¶

POST /quotes/{quoteLocator}/createNew

Request:

Name	Position	Type	Required
addedChanges	body	PolicyQuoteUpdateRequest	optional
quoteLocator	path	string	required

Response: PolicyQuoteResponse

Select a quote¶

PATCH /quotes/{quoteLocator}/select

Request:

Name	Position	Type	Required
quoteLocator	path	string	required

Response: void

Note

The selected quote is used to determine which quote’s data is sent back with a PolicyResponse and which quote is displayed in the UI. It is also the quote that will be bound if the policy is finalized through the /policy API.

Price a quote and lock in details¶

PATCH /quotes/{quoteLocator}/quote

Request:

Name	Position	Type	Required
quoteLocator	path	string	required

Response: PolicyPriceResponse

Fetch pricing for a quote that has already been quoted¶

GET /quotes/{quoteLocator}/price

Request:

Name	Position	Type	Required
quoteLocator	path	string	required

Response: PolicyPriceResponse

Accept a quote¶

PATCH /quotes/{quoteLocator}/accept

Request:

Name	Position	Type	Required
quoteLocator	path	string	required

Response: PolicyQuoteResponse

Invalidate a previously accepted quote¶

PATCH /quotes/{quoteLocator}/invalidate

Request:

Name	Position	Type	Required
quoteLocator	path	string	required

Response: PolicyQuoteResponse

Discard a quote¶

PATCH /quotes/{quoteLocator}/discard

Request:

Name	Position	Type	Required
quoteLocator	path	string	required

Response: PolicyQuoteResponse

QuoteSummaryResponse¶

required
selected string
notDiscarded [QuoteSummaryResponseItem]

QuoteSummaryResponseItem¶

required
locator string
name string
state string draft | quoted | accepted | declined | discarded