Quotes API

Action	Endpoint
Fetch a Quote	GET/policy/{tenantLocator}/quotes/{locator}
Fetch All Quotes	GET/policy/{tenantLocator}/quotes/list
Create a Quote	POST/policy/{tenantLocator}/quotes
Update a Quote	PATCH/policy/{tenantLocator}/quotes/{locator}
Add Elements to a Quote	PUT/policy/{tenantLocator}/quotes/{locator}/elements
Remove Elements from a Quote	DELETE/policy/{tenantLocator}/quotes/{locator}/elements
Validate a Quote	PATCH/policy/{tenantLocator}/quotes/{locator}/validate
Get a stateless validation preview for a hypothetical quote	POST/policy/{tenantLocator}/quotes/validatePreview
Price a Quote	PATCH/policy/{tenantLocator}/quotes/{locator}/price
Fetch Quote Pricing	GET/policy/{tenantLocator}/quotes/{locator}/price
Get a stateless price preview for a hypothetical quote	POST/policy/{tenantLocator}/quotes/pricePreview
Underwrite a Quote	PATCH/policy/{tenantLocator}/quotes/{locator}/underwrite
Fetch Underwriting Flags	GET/policy/{tenantLocator}/quotes/{locator}/underwritingFlags
Update a Quote's Underwriting Flags	PATCH/policy/{tenantLocator}/quotes/{locator}/underwritingFlags
Add Approve Level Underwriting Flag for Quote	POST/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/approve
Add Decline Level Underwriting Flag for Quote	POST/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/decline
Add Block Level Underwriting Flag for Quote	POST/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/block
Add Reject Level Underwriting Flag for Quote	POST/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/reject
Add Info Level Underwriting Flag for Quote	POST/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/info
Clear Approve Level Underwriting Flag for Quote	DELETE/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/approve/{flagLocator}
Clear Decline Level Underwriting Flag for Quote	DELETE/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/decline/{flagLocator}
Clear Block Level Underwriting Flag for Quote	DELETE/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/block/{flagLocator}
Clear Reject Level Underwriting Flag for Quote	DELETE/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/reject/{flagLocator}
Clear Info Level Underwriting Flag for Quote	DELETE/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/info/{flagLocator}
Accept a Quote	PATCH/policy/{tenantLocator}/quotes/{locator}/accept
Issue a Quote	PATCH/policy/{tenantLocator}/quotes/{locator}/issue
Copy a Quote	POST/policy/{tenantLocator}/quotes/{locator}/copy
Create Quote Group	POST/policy/{tenantLocator}/quotes/groups
Fetch Quote Group	GET/policy/{tenantLocator}/quotes/groups/{locator}
Fetch All Quotes In Group	GET/policy/{tenantLocator}/quotes/groups/{locator}/list
Fetch Quote Group By Name	GET/policy/{tenantLocator}/quotes/groups/name/{name}
Fetch Quote Groups In ATenant	GET/policy/{tenantLocator}/quotes/groups/list
Update Quote Group	PATCH/policy/{tenantLocator}/quotes/groups/{locator}
Validate Quote Group	PATCH/policy/{tenantLocator}/quotes/groups/{locator}/validate
Delete Quote Group	DELETE/policy/{tenantLocator}/quotes/groups/{locator}
Assign Quote Group	PATCH/policy/{tenantLocator}/quotes/{locator}/assignToGroup
Add Static Data to a Quote	POST/policy/{tenantLocator}/quotes/{locator}/static
Update Static Data on a Quote	PATCH/policy/{tenantLocator}/quotes/{locator}/static
Replace All Static Data on a Quote	PUT/policy/{tenantLocator}/quotes/{locator}/static
Fetch Static Data for a Quote	GET/policy/{tenantLocator}/quotes/{locator}/static
List Static Data for a Quote	GET/policy/{tenantLocator}/quotes/{locator}/static/history/list
Update Billing Level For AQuote	PATCH/policy/{tenantLocator}/quotes/{locator}/billingLevel
Add quote contact	POST/policy/{tenantLocator}/quotes/{quoteLocator}/contacts
Delete quote contact	DELETE/policy/{tenantLocator}/quotes/{quoteLocator}/contacts/{contactLocator}
Fetch quote contacts	GET/policy/{tenantLocator}/quotes/{quoteLocator}/contacts
Update quote contact	PATCH/policy/{tenantLocator}/quotes/{quoteLocator}/contacts/{contactLocator}
Fetch Quotes With Number	GET/policy/{tenantLocator}/quotes/numbers/{quoteNumber}
Set Quote Number	POST/policy/{tenantLocator}/quotes/{locator}/number/set
Generate Quote Number	POST/policy/{tenantLocator}/quotes/{locator}/number/generate
Reset a Quote	PATCH/policy/{tenantLocator}/quotes/{locator}/reset
Refuse a Quote (Insured Declined Coverage)	PATCH/policy/{tenantLocator}/quotes/{locator}/refuse
Discard a Quote	PATCH/policy/{tenantLocator}/quotes/{locator}/discard
Invoke the precommit plugin for a draft quote	PATCH/policy/{tenantLocator}/quotes/{locator}/precommit

Main Flow

Fetch

Fetch a Quote

Fetch a QuotefetchQuote

GET/policy/{tenantLocator}/quotes/{locator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:QuoteResponse

Security Group:quotes

Permission:

read

Fetch All Quotes

Fetch All QuotesfetchQuotesInATenant

GET/policy/{tenantLocator}/quotes/list

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No	When false, returns a bare array.

Response:QuoteListResponse

Security Group:quotes

Permissions:

read,list

Fetch All Quotes for an Account

Fetch All Quotes for an AccountfetchQuotesForAccount

GET/policy/{tenantLocator}/accounts/{locator}/quotes/list

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`includeStaticData`	query	`boolean?`	No
`extended`	query	`boolean?`	No	When false, returns a bare array.

Response:QuoteListResponse

Security Group:accounts

Permissions:

read,list

QuoteListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`QuoteResponse[]`

QuoteResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`accountLocator`	`ulid`
`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
`contacts`	`ContactRoles[]`

Optional properties

Property	Type	Description
`policyLocator`	`ulid?`
`groupLocator`	`ulid?`
`quickQuoteLocator`	`ulid?`
`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?`
`anonymizedAt`	`datetime?`
`expirationTime`	`datetime?`
`invoiceFeeAmount`	`number?`
`jurisdiction`	`string?`
`policyNumber`	`string?`
`preferences`	`PreferencesResponse?`	Plan selections and setting overrides
`producerCode`	`string?`
`quoteNumber`	`string?`
`reservedPolicyNumber`	`string?`
`underwritingStatus`	`string?`
`validationResult`	`ValidationResult?`
`static`	`map<string, object>?`
`createdAt`	`datetime?`
`createdBy`	`uuid?`

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

ElementResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`staticLocator`	`ulid`
`parentLocator`	`ulid`
`originalEffectiveTime`	`datetime`	Indicates when the element was first added to the policy
`type`	`string`

Optional properties

Property	Type	Description
`category`	`Enum? product \| coverage \| exposure \| exposureGroup \| policyLine`
`data`	`map<string, object>?`
`coverageTerms`	`map<string, object>?`
`elements`	`ElementResponse[]?`

PreferencesResponse

Properties

Property	Type	Description
`installmentPreferences`	`InstallmentPreferences?`

InstallmentPreferences

Required properties

Property	Type	Description
`installmentWeights`	`number[]`

Optional properties

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

Quote Creation

Create a Quote

Create a QuotecreateQuote

POST/policy/{tenantLocator}/quotes

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes

Request:QuoteCreateRequest

Response:QuoteResponse

Security Group:quotes

Permissions:

write,create

QuoteCreateRequest

Required properties

Property	Type	Description
`accountLocator`	`ulid`
`productName`	`string`
`startTime`	`datetime`
`invoiceFeeAmount`	`number`
`data`	`map<string, object>`
`contacts`	`ContactRoles[]`

Optional properties

Property	Type	Description
`quoteGroupLocator`	`ulid?`
`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?`
`jurisdiction`	`string?`
`preferences`	`PreferencesResponse?`
`producerCode`	`string?`
`termDuration`	`integer?`
`static`	`map<string, object>?`
`coverageTerms`	`map<string, object>?`
`elements`	`ElementCreateRequest[]?`

ElementCreateRequest

Required properties

Property	Type	Description
`type`	`string`

Optional properties

Property	Type	Description
`staticLocator`	`ulid?`
`parentLocator`	`ulid?`
`data`	`map<string, object>?`
`coverageTerms`	`map<string, object>?`
`elements`	`ElementCreateRequest[]?`

Update

Update a Quote

Update a QuoteupdateQuote

PATCH/policy/{tenantLocator}/quotes/{locator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:QuoteUpdateRequest

Response:QuoteResponse

Security Group:quotes

Permissions:

write,update

QuoteUpdateRequest

Required properties

Property	Type	Description
`accountLocator`	`ulid`
`autoRenewalPlanName`	`string`
`delinquencyPlanName`	`string`
`startTime`	`datetime`
`endTime`	`datetime`
`currency`	`string`
`timezone`	`string`
`billingLevel`	`Enum account \| inherit \| policy`
`expirationTime`	`datetime`
`invoiceFeeAmount`	`number`
`preferences`	`PreferencesResponse`
`resetEndTime`	`boolean`
`elements`	`ElementUpdateRequest[]`
`removeContacts`	`ulid[]`
`removeCoverageTerms`	`map<string, object>`
`removeData`	`map<string, object>`
`setContacts`	`ContactRoles[]`
`setCoverageTerms`	`map<string, object>`
`setData`	`map<string, object>`

Optional properties

Property	Type	Description
`jurisdiction`	`string?`
`producerCode`	`string?`

ElementUpdateRequest

Required properties

Property	Type	Description
`locator`	`ulid`
`removeCoverageTerms`	`map<string, object>`
`removeData`	`map<string, object>`
`setCoverageTerms`	`map<string, object>`
`setData`	`map<string, object>`

Add Elements to a Quote

Add Elements to a QuoteaddElementsToQuote

PUT/policy/{tenantLocator}/quotes/{locator}/elements

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:ElementCreateRequest[]

Response:QuoteResponse

Security Group:quotes

Permissions:

write,elements-add

Remove Elements from a Quote

Remove Elements from a QuoteremoveElementsFromQuote

DELETE/policy/{tenantLocator}/quotes/{locator}/elements

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:ulid[]

Response:QuoteResponse

Security Group:quotes

Permissions:

write,elements-delete

Validation

Validate a Quote

Validate a QuotevalidateQuote

PATCH/policy/{tenantLocator}/quotes/{locator}/validate

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`stateless`	query	`boolean?`	No

Response:QuoteResponse

Security Group:quotes

Permissions:

write,validate

ValidationResult

Required properties

Property	Type	Description
`success`	`boolean`

Optional properties

Property	Type	Description
`validationItems`	`ValidationItemResponse[]?`

ValidationItemResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`elementType`	`string`
`errors`	`string[]`

Get a stateless validation preview for a hypothetical quote

Get a stateless validation preview for a hypothetical quotequoteValidatePreview

POST/policy/{tenantLocator}/quotes/validatePreview

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes

Request:QuoteCreateRequest

Response:QuoteResponse

Security Group:quotes

Permission:

read

Pricing

Price a Quote

Price a QuotepriceQuote

PATCH/policy/{tenantLocator}/quotes/{locator}/price

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`stateless`	query	`boolean?`	No

Response:QuotePriceResponse

Security Group:quotes

Permissions:

write,price

Fetch Quote Pricing

Fetch Quote PricingfetchPricedQuote

GET/policy/{tenantLocator}/quotes/{locator}/price

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:QuotePriceResponse

Security Group:quotes

Permission:

read

QuotePriceResponse

Required properties

Property	Type	Description
`accountLocator`	`ulid`
`quoteLocator`	`ulid`
`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`
`items`	`PolicyChargeResponse[]`

Optional properties

Property	Type	Description
`quoteNumber`	`string?`
`validationResult`	`ValidationResult?`

ChargeResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`accountLocator`	`ulid`
`currency`	`string`
`amount`	`number`
`chargeCategory`	`Enum none \| premium \| tax \| fee \| credit \| invoiceFee \| cededPremium \| nonFinancial \| surcharge`
`chargeInvoicing`	`Enum scheduled \| next \| immediate`
`chargeType`	`string`

Optional properties

Property	Type	Description
`policyLocator`	`ulid?`
`transactionLocator`	`ulid?`
`bundleTransactionLocator`	`ulid?`
`elementLocator`	`ulid?`
`elementStaticLocator`	`ulid?`
`reversalOfLocator`	`ulid?`
`tag`	`string?`

Get a stateless price preview for a hypothetical quote

Get a stateless price preview for a hypothetical quotequotePricePreview

POST/policy/{tenantLocator}/quotes/pricePreview

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes

Request:QuoteCreateRequest

Response:QuotePriceResponse

Security Group:quotes

Permission:

read

Underwriting

Underwrite a Quote

Underwrite a QuoteunderwriteQuote

PATCH/policy/{tenantLocator}/quotes/{locator}/underwrite

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`stateless`	query	`boolean?`	No

Response:QuoteUnderwritingResponse

Security Group:quotes

Permissions:

write,underwrite

QuoteUnderwritingResponse

Required properties

Property	Type	Description
`accountLocator`	`ulid`
`quoteLocator`	`ulid`
`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[]`

Optional properties

Property	Type	Description
`validationResult`	`ValidationResult?`

Underwriting Flags

Fetch Underwriting Flags

Fetch Underwriting FlagsfetchUnderwritingFlagsForQuote

GET/policy/{tenantLocator}/quotes/{locator}/underwritingFlags

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:QuoteUnderwritingFlagsResponse

Security Group:quotes

Permission:

read

QuoteUnderwritingFlagsResponse

Required properties

Property	Type	Description
`quoteLocator`	`ulid`
`flags`	`UnderwritingFlagResponse[]`

Optional properties

Property	Type	Description
`clearedFlags`	`UnderwritingFlagResponse[]?`

UnderwritingFlagResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`referenceLocator`	`ulid`
`clearedBy`	`uuid`
`clearedTime`	`datetime`
`createdTime`	`datetime`
`level`	`Enum info \| block \| decline \| reject \| approve`
`note`	`string`
`referenceType`	`Enum quote \| transaction`
`tag`	`string`
`taskCreationResponse`	`TaskCreationResponse`
`createdBy`	`uuid`

Optional properties

Property	Type	Description
`elementLocator`	`ulid?`

Update a Quote's Underwriting Flags

Update a Quote's Underwriting FlagsupdateUnderwritingFlagsForQuote

PATCH/policy/{tenantLocator}/quotes/{locator}/underwritingFlags

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:UnderwritingFlagsUpdateRequest

Response:QuoteUnderwritingFlagsResponse

Security Group:quotes

Permission:

write

UnderwritingFlagsUpdateRequest

Required properties

Property	Type	Description
`addFlags`	`UnderwritingFlagCreateRequest[]`
`clearFlags`	`ulid[]`

UnderwritingFlagCreateRequest

Required properties

Property	Type	Description
`elementLocator`	`ulid`
`level`	`Enum info \| block \| decline \| reject \| approve`
`note`	`string`
`tag`	`string`
`taskCreation`	`UnderwritingTaskCreateRequest`

UnderwritingTaskCreateRequest

Required properties

Property	Type	Description
`type`	`string`
`references`	`TaskReference[]`
`underwritingFlagLocators`	`ulid[]`

Optional properties

Property	Type	Description
`workgroupToBeAssignedLocator`	`ulid?`
`assignedTo`	`uuid?`
`deadlineTime`	`datetime?`
`description`	`string?`
`source`	`string?`
`tag`	`string?`

Add Approve Level Underwriting Flag for Quote

Add Approve Level Underwriting Flag for QuoteaddUnderwritingApproveFlagForQuote

POST/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/approve

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:UnderwritingFlagCreateRequest

Response:QuoteUnderwritingFlagsResponse

Security Group:quotes

Permissions:

write,approve-add

Add Decline Level Underwriting Flag for Quote

Add Decline Level Underwriting Flag for QuoteaddUnderwritingDeclineFlagForQuote

POST/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/decline

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:UnderwritingFlagCreateRequest

Response:QuoteUnderwritingFlagsResponse

Security Group:quotes

Permissions:

write,decline-add

Add Block Level Underwriting Flag for Quote

Add Block Level Underwriting Flag for QuoteaddUnderwritingBlockFlagForQuote

POST/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/block

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:UnderwritingFlagCreateRequest

Response:QuoteUnderwritingFlagsResponse

Security Group:quotes

Permissions:

write,block-add

Add Reject Level Underwriting Flag for Quote

Add Reject Level Underwriting Flag for QuoteaddUnderwritingRejectFlagForQuote

POST/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/reject

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:UnderwritingFlagCreateRequest

Response:QuoteUnderwritingFlagsResponse

Security Group:quotes

Permissions:

write,reject-add

Add Info Level Underwriting Flag for Quote

Add Info Level Underwriting Flag for QuoteaddUnderwritingInfoFlagForQuote

POST/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/info

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:UnderwritingFlagCreateRequest

Response:QuoteUnderwritingFlagsResponse

Security Group:quotes

Permissions:

write,info-add

Clear Approve Level Underwriting Flag for Quote

Clear Approve Level Underwriting Flag for QuoteclearUnderwritingApproveFlagForQuote

DELETE/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/approve/{flagLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`flagLocator`	path	`ulid`	Yes

Response:QuoteUnderwritingFlagsResponse

Security Group:quotes

Permissions:

write,approve-clear

Clear Decline Level Underwriting Flag for Quote

Clear Decline Level Underwriting Flag for QuoteclearUnderwritingDeclineFlagForQuote

DELETE/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/decline/{flagLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`flagLocator`	path	`ulid`	Yes

Response:QuoteUnderwritingFlagsResponse

Security Group:quotes

Permissions:

write,decline-clear

Clear Block Level Underwriting Flag for Quote

Clear Block Level Underwriting Flag for QuoteclearUnderwritingBlockFlagForQuote

DELETE/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/block/{flagLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`flagLocator`	path	`ulid`	Yes

Response:QuoteUnderwritingFlagsResponse

Security Group:quotes

Permissions:

write,block-clear

Clear Reject Level Underwriting Flag for Quote

Clear Reject Level Underwriting Flag for QuoteclearUnderwritingRejectFlagForQuote

DELETE/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/reject/{flagLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`flagLocator`	path	`ulid`	Yes

Response:QuoteUnderwritingFlagsResponse

Security Group:quotes

Permissions:

write,reject-clear

Clear Info Level Underwriting Flag for Quote

Clear Info Level Underwriting Flag for QuoteclearUnderwritingInfoFlagForQuote

DELETE/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/info/{flagLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`flagLocator`	path	`ulid`	Yes

Response:QuoteUnderwritingFlagsResponse

Security Group:quotes

Permissions:

write,info-clear

Acceptance

Accept a Quote

Accept a QuoteacceptQuote

PATCH/policy/{tenantLocator}/quotes/{locator}/accept

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:QuoteResponse

Security Group:quotes

Permissions:

write,accept

Issuance

Issue a Quote

Issue a QuoteissueQuote

PATCH/policy/{tenantLocator}/quotes/{locator}/issue

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:QuoteResponse

Security Group:quotes

Permissions:

write,issue

Copying

Copy a Quote

Copy a QuotecopyQuote

POST/policy/{tenantLocator}/quotes/{locator}/copy

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:QuoteGroupAssignmentRequest

Response:QuoteResponse

Security Group:quotes

Permissions:

write,create

Create Quote From Policy

Create Quote From PolicycreateQuoteFromPolicy

POST/policy/{tenantLocator}/policies/{locator}/quote

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`date`	query	`datetime?`	No
`byIssuedTime`	query	`boolean?`	No
`includeStaticData`	query	`boolean?`	No

Response:QuoteResponse

Security Group:policies

Permissions:

write,create-quote

Quote Groups

Create Quote Group

Create Quote GroupcreateQuoteGroup

POST/policy/{tenantLocator}/quotes/groups

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes

Request:QuoteGroupCreateRequest

Response:QuoteGroupResponse

Security Group:quotes

Permission:

write

QuoteGroupCreateRequest

Required properties

Property	Type	Description
`preferredQuoteLocator`	`ulid`
`name`	`string`
`quoteGroupNumber`	`string`
`settings`	`QuoteGroupSettings`
`quoteLocators`	`ulid[]`

QuoteGroupSettings

Required properties

Property	Type	Description
`enforceProductUniformity`	`boolean`	default: false
`stateUniqueness`	`Enum draft \| validated \| earlyUnderwritten \| priced \| underwritten \| accepted \| issued \| underwrittenBlocked \| declined \| rejected \| refused \| discarded`
`fieldEnforcementDeclarations`	`QuoteGroupFieldEnforcementDeclaration[]`

QuoteGroupFieldEnforcementDeclaration

Required properties

Property	Type	Description
`name`	`string`
`paths`	`map<string, string>`

QuoteGroupResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`name`	`string`
`quoteGroupState`	`Enum open \| locked`
`settings`	`QuoteGroupSettings`
`createdAt`	`datetime`
`createdBy`	`uuid`
`quoteLocators`	`ulid[]`

Optional properties

Property	Type	Description
`preferredQuoteLocator`	`ulid?`
`quoteGroupNumber`	`string?`

Fetch Quote Group

Fetch Quote GroupfetchQuoteGroup

GET/policy/{tenantLocator}/quotes/groups/{locator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:QuoteGroupResponse

Security Group:quotes

Permission:

read

Fetch All Quotes In Group

Fetch All Quotes In GroupfetchAllQuotesInGroup

GET/policy/{tenantLocator}/quotes/groups/{locator}/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseQuote

Security Group:quotes

Permissions:

read,list

ListPageResponseQuote

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`QuickQuoteQuoteDetails[]`

Fetch Quote Group By Name

Fetch Quote Group By NamefetchQuoteGroupByName

GET/policy/{tenantLocator}/quotes/groups/name/{name}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`name`	path	`string`	Yes

Response:QuoteGroupResponse

Security Group:quotes

Permission:

read

Fetch Quote Groups In ATenant

Fetch Quote Groups In A TenantfetchQuoteGroupsInATenant

GET/policy/{tenantLocator}/quotes/groups/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseQuoteGroup

Security Group:quotes

Permissions:

read,list

ListPageResponseQuoteGroup

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`QuoteGroupResponse[]`

Update Quote Group

Update Quote GroupupdateQuoteGroup

PATCH/policy/{tenantLocator}/quotes/groups/{locator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:QuoteGroupUpdateRequest

Response:QuoteGroupResponse

Security Group:quotes

Permission:

write

QuoteGroupUpdateRequest

Required properties

Property	Type	Description
`preferredQuoteLocator`	`ulid`
`name`	`string`
`quoteGroupNumber`	`string`
`resetPreferredQuote`	`boolean`
`quotesToAdd`	`ulid[]`
`quotesToRemove`	`ulid[]`

Validate Quote Group

Validate Quote GroupvalidateQuoteGroup

PATCH/policy/{tenantLocator}/quotes/groups/{locator}/validate

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:QuoteGroupValidationResponse

Security Group:quotes

Permissions:

write,validate

QuoteGroupValidationResponse

Required properties

Property	Type	Description
`valid`	`boolean`
`errors`	`string[]`

Delete Quote Group

Delete Quote GroupdeleteQuoteGroup

DELETE/policy/{tenantLocator}/quotes/groups/{locator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:void

Security Group:quotes

Permission:

write

Assign Quote Group

Assign Quote GroupassignQuoteGroup

PATCH/policy/{tenantLocator}/quotes/{locator}/assignToGroup

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:QuoteGroupAssignmentRequest

Response:QuoteResponse

Security Group:quotes

Permission:

write

QuoteGroupAssignmentRequest

Required properties

Property	Type	Description
`groupLocator`	`ulid`

Static Data

Add Static Data to a Quote

Add Static Data to a QuoteaddStaticDataForQuote

POST/policy/{tenantLocator}/quotes/{locator}/static

Set the static extension data on a quote

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:map<string, object>

Response:QuoteResponse

Security Group:quotes

Permissions:

write,static-data-add

Update Static Data on a Quote

Update Static Data on a QuoteupdateStaticDataForQuote

PATCH/policy/{tenantLocator}/quotes/{locator}/static

Updates some of the static data on a quote

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:StaticDataUpdateRequest

Response:QuoteResponse

Security Group:quotes

Permissions:

write,static-data-update

StaticDataUpdateRequest

Required properties

Property	Type	Description
`removeData`	`map<string, object>`
`setData`	`map<string, object>`

Replace All Static Data on a Quote

Replace All Static Data on a QuotereplaceAllStaticDataForQuote

PUT/policy/{tenantLocator}/quotes/{locator}/static

Replaces all of the static data on a quote

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:map<string, object>

Response:QuoteResponse

Security Group:quotes

Permissions:

write,static-data-add

Fetch Static Data for a Quote

Fetch Static Data for a QuotefetchStaticDataForQuote

GET/policy/{tenantLocator}/quotes/{locator}/static

Gets static data for a quote

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:map<string, object>

Security Group:quotes

Permission:

read

List Static Data for a Quote

List Static Data for a QuotelistStaticDataForQuote

GET/policy/{tenantLocator}/quotes/{locator}/static/history/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseStaticDataHistoryResponse

Security Group:quotes

Permission:

read

ListPageResponseStaticDataHistoryResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`StaticDataHistoryResponse[]`

StaticDataHistoryResponse

Required properties

Property	Type	Description
`historyLocator`	`ulid`
`updatedAt`	`datetime`
`updatedBy`	`uuid`
`staticData`	`map<string, object>`

Documents

Fetch Documents for a Quote

Fetch Documents for a QuotefetchDocumentsForQuote

GET/document/{tenantLocator}/documents/quote/{locator}/list

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No	When false, returns a bare array.
`suppressRenderingData`	query	`boolean?`	No

Response:DocumentListResponse

Security Group:documents

Permission:

read

DocumentInstanceResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`referenceLocator`	`ulid`
`documentInstanceState`	`Enum draft \| dataReady \| ready \| dataError \| renderError \| conversionError \| rendered`
`documentFormat`	`Enum csv \| doc \| docx \| html \| jpeg \| jpg \| pdf \| text \| txt \| xls \| xlsx \| zip`
`external`	`boolean`
`referenceType`	`Enum quote \| policy \| invoice \| transaction \| segment \| term`
`createdAt`	`datetime`
`consolidatedFrom`	`ulid[]`
`consolidatedTo`	`ulid[]`
`metadata`	`map<string, object>`
`renderingData`	`map<string, object>`

Optional properties

Property	Type	Description
`policyLocator`	`ulid?`
`termLocator`	`ulid?`
`transactionLocator`	`ulid?`
`segmentLocator`	`ulid?`
`referenceDocumentLocator`	`ulid?`
`staticName`	`string?`
`name`	`string?`
`category`	`string?`
`copyOnIssuance`	`boolean?`
`processingErrors`	`string?`
`readyAt`	`datetime?`
`createdBy`	`uuid?`

Billing

Update Billing Level For AQuote

Update Billing Level For A QuoteupdateBillingLevelForAQuote

PATCH/policy/{tenantLocator}/quotes/{locator}/billingLevel

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:UpdateBillingLevelRequest

Response:QuoteResponse

Security Group:quotes

Permission:

write

UpdateBillingLevelRequest

Required properties

Property	Type	Description
`billingLevel`	`Enum account \| inherit \| policy`

Update the Delinquency Plan Assigned to a Quote

Update the Delinquency Plan Assigned to a QuoteupdateQuoteDelinquencyPlan

PATCH/policy/{tenantLocator}/quotes/{locator}/delinquencyPlan

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:DelinquencyPlanUpdateRequest

Response:QuoteResponse

Security Group:quotes

Permission:

write

Contacts

Add quote contact

Add quote contactaddQuoteContact

POST/policy/{tenantLocator}/quotes/{quoteLocator}/contacts

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`quoteLocator`	path	`ulid`	Yes

Request:ContactRoles

Response:QuoteResponse

Security Group:quotes

Permission:

write

ContactRoles

Required properties

Property	Type	Description
`contactLocator`	`ulid`
`roles`	`string[]`

Delete quote contact

Delete quote contactdeleteQuoteContact

DELETE/policy/{tenantLocator}/quotes/{quoteLocator}/contacts/{contactLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`quoteLocator`	path	`ulid`	Yes
`contactLocator`	path	`ulid`	Yes

Response:QuoteResponse

Security Group:quotes

Permission:

write

Fetch quote contacts

Fetch quote contactsfetchQuoteContacts

GET/policy/{tenantLocator}/quotes/{quoteLocator}/contacts

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`quoteLocator`	path	`ulid`	Yes

Response:ContactRoles[]

Security Group:quotes

Permission:

write

Update quote contact

Update quote contactupdateQuoteContact

PATCH/policy/{tenantLocator}/quotes/{quoteLocator}/contacts/{contactLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`quoteLocator`	path	`ulid`	Yes
`contactLocator`	path	`ulid`	Yes

Request:ContactAssociationUpdateRequest

Response:QuoteResponse

Security Group:quotes

Permission:

write

Numbering

Fetch Quotes With Number

Fetch Quotes With NumberfetchQuotesWithNumber

GET/policy/{tenantLocator}/quotes/numbers/{quoteNumber}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`quoteNumber`	path	`string`	Yes

Response:QuoteResponse[]

Security Group:quotes

Permissions:

read,list

Set Quote Number

Set Quote NumbersetQuoteNumber

POST/policy/{tenantLocator}/quotes/{locator}/number/set

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`quoteNumber`	query	`string`	Yes

Response:QuoteResponse

Security Group:quotes

Permission:

write

Generate Quote Number

Generate Quote NumbergenerateQuoteNumber

POST/policy/{tenantLocator}/quotes/{locator}/number/generate

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:QuoteResponse

Security Group:quotes

Permission:

write

Holds

Fetch Quote Holds

Fetch Quote HoldsfetchQuoteHolds

GET/policy/{tenantLocator}/quotes/{locator}/holds

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:EntityHold[]

Security Group:quotes

Permission:

read

Atypical States and Operations

Reset a Quote

Reset a QuoteresetQuote

PATCH/policy/{tenantLocator}/quotes/{locator}/reset

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:ResetOptions

Response:QuoteResponse

Security Group:quotes

Permissions:

write,reset

ResetOptions

Required properties

Property	Type	Description
`deleteAllAutomaticDocuments`	`boolean`
`discardSchedules`	`boolean`
`resetAllUnderwritingFlags`	`boolean`
`resetFlagsAction`	`Enum clear \| delete`
`deleteDocuments`	`ulid[]`
`resetFlags`	`ulid[]`

Refuse a Quote (Insured Declined Coverage)

Refuse a Quote (Insured Declined Coverage)refuseQuote

PATCH/policy/{tenantLocator}/quotes/{locator}/refuse

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:QuoteResponse

Security Group:quotes

Permissions:

write,refuse

Discard a Quote

Discard a QuotediscardQuote

PATCH/policy/{tenantLocator}/quotes/{locator}/discard

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:QuoteResponse

Security Group:quotes

Permissions:

write,discard

Invoke the precommit plugin for a draft quote

Invoke the precommit plugin for a draft quoteprecommitQuote

PATCH/policy/{tenantLocator}/quotes/{locator}/precommit

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:QuoteResponse

Security Group:quotes

Permissions:

write,precommit

Quotes API

On this page