Quotes API
Endpoint Index
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 |
Price a Quote | PATCH /policy/{tenantLocator}/quotes/{locator}/price |
Fetch Quote Pricing | GET /policy/{tenantLocator}/quotes/{locator}/price |
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 |
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 |
Assign Quote Group | PATCH /policy/{tenantLocator}/quotes/{locator}/assignToGroup |
Fetch All Quotes In Group | GET /policy/{tenantLocator}/quotes/group/{locator}/list |
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 |
Update Billing Level for a Quote | PATCH /policy/{tenantLocator}/quotes/{locator}/billingLevel |
Fetch Quotes with Number | GET /policy/{tenantLocator}/quotes/numbers/{quoteNumber} |
Set Quote Number | POST /policy/{tenantLocator}/quotes/{locator}/number/set |
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 |
Main Flow
Fetch
GET /policy/{tenantLocator}/quotes/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:QuoteResponse
Security Group:quotes  Permission:read
This endpoint will be removed in a future release.
GET /policy/{tenantLocator}/quotes/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
offset | query | int? | optional |
count | query | int? | optional |
extended | query | boolean? | optional |
Response:QuoteListResponse
Security Group:quotes  Permissions:read,list
GET /policy/{tenantLocator}/accounts/{locator}/quotes/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
offset | query | int? | optional |
count | query | int? | optional |
includeStaticData | query | boolean? | optional |
extended | query | boolean? | optional |
Response:QuoteListResponse
Security Group:accounts  Permissions:read,list
QuoteListResponse
¶requiredlistCompleted booleanitems QuoteResponse[]
QuoteResponse
¶requiredlocator locatoraccountLocator locatorgroupLocator locatorproductName stringquoteState Enum draft | validated | earlyUnderwritten | priced | underwritten | accepted | issued | underwrittenBlocked | declined | rejected | refused | discardedbillingLevel Enum account | inherit | policyoptionalpolicyLocator 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 durationBasisdurationBasis Enum? years | months | weeks | days | hourstimezone string?expirationTime datetime?policyNumber string?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
¶requiredlocator locatorstaticLocator locatorparentLocator locatororiginalEffectiveTime datetime
Indicates when the element was first added to the policytype stringoptionalcategory Enum? product | coverage | exposure | exposureGroup | policyLinedata map<string,object>?coverageTerms map<string,string>?elements ElementResponse[]?
PreferencesResponse
¶optionalbillingPreferences BillingPreferences?installmentPreferences InstallmentPreferences?
BillingPreferences
¶optionalbillingPlanName string?billingLevel Enum? account | inherit | policy
InstallmentPreferences
¶requiredinstallmentWeights number[]optionalinstallmentPlanName string?anchorMode Enum? generateDay | termStartDay | dueDayanchorTime datetime?anchorType Enum? none | dayOfMonth | anchorTime | dayOfWeek | weekOfMonthcadence Enum? none | fullPay | weekly | everyOtherWeek | monthly | quarterly | semiannually | annually | thirtyDays | everyNDaysdayOfMonth int?dayOfWeek Enum? monday | tuesday | wednesday | thursday | friday | saturday | sundaydueLeadDays int?generateLeadDays int?maxInstallmentsPerTerm int?weekOfMonth Enum? none | first | second | third | fourth | fifth
Quote Creation
POST /policy/{tenantLocator}/quotes
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
Request:QuoteCreateRequest
Response:QuoteResponse
Security Group:quotes  Permission:write
QuoteCreateRequest
¶requiredaccountLocator locatorproductName stringstartTime datetimedata map<string,object>optionalregion string?autoRenewalPlanName string?delinquencyPlanName string?endTime datetime?currency string?durationBasis Enum? years | months | weeks | days | hourstimezone string?billingLevel Enum? account | inherit | policyexpirationTime datetime?preferences PreferencesResponse?static map<string,object>?coverageTerms map<string,string>?elements ElementCreateRequest[]?billingTrigger Enum? accept | issue (deprecated)
ElementCreateRequest
¶requiredtype stringoptionalstaticLocator locator?parentLocator locator?data map<string,object>?coverageTerms map<string,string>?elements ElementCreateRequest[]?
Update
PATCH /policy/{tenantLocator}/quotes/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:QuoteUpdateRequest
Response:QuoteResponse
Security Group:quotes  Permission:write
QuoteUpdateRequest
¶requiredautoRenewalPlanName stringdelinquencyPlanName stringstartTime datetimeendTime datetimecurrency stringbillingLevel Enum account | inherit | policyexpirationTime datetimepreferences PreferencesResponseelements ElementUpdateRequest[]removeCoverageTerms map<string,object>removeData map<string,object>setCoverageTerms map<string,string>setData map<string,object>billingTrigger Enum accept | issue (deprecated)
ElementUpdateRequest
¶requiredlocator locatorremoveCoverageTerms map<string,object>removeData map<string,object>setCoverageTerms map<string,string>setData map<string,object>
PUT /policy/{tenantLocator}/quotes/{locator}/elements
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:ElementCreateRequest[]
Response:QuoteResponse
Security Group:quotes  Permission:write
DELETE /policy/{tenantLocator}/quotes/{locator}/elements
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:locator[]
Response:QuoteResponse
Security Group:quotes  Permission:write
Validation
PATCH /policy/{tenantLocator}/quotes/{locator}/validate
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
stateless | query | boolean? | optional |
Response:QuoteResponse
Security Group:quotes  Permission:write
ValidationResult
¶requiredsuccess booleanoptionalvalidationItems ValidationItemResponse[]?
ValidationItemResponse
¶requiredlocator locatorelementType stringerrors string[]
Pricing
PATCH /policy/{tenantLocator}/quotes/{locator}/price
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
stateless | query | boolean? | optional |
Response:QuotePriceResponse
Security Group:quotes  Permission:write
GET /policy/{tenantLocator}/quotes/{locator}/price
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:QuotePriceResponse
Security Group:quotes  Permission:read
QuotePriceResponse
¶requiredaccountLocator locatorquoteLocator locatortenantLocator uuidproductName stringstartTime datetimeendTime datetimeduration numberdurationBasis Enum years | months | weeks | days | hoursquoteState Enum draft | validated | earlyUnderwritten | priced | underwritten | accepted | issued | underwrittenBlocked | declined | rejected | refused | discardeditems ChargeResponse[]optionalquoteNumber string?
ChargeResponse
¶requiredlocator locatorelementLocator locatorelementStaticLocator locatoramount numberchargeCategory Enum premium | tax | fee | credit | nonFinancial | surchargechargeType stringrate numberreferenceRate numberoptionalreversalOfLocator locator?rateDifference number?tag string?
Underwriting
PATCH /policy/{tenantLocator}/quotes/{locator}/underwrite
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
stateless | query | boolean? | optional |
Response:QuoteUnderwritingResponse
Security Group:quotes  Permission:write
QuoteUnderwritingResponse
¶requiredaccountLocator locatorquoteLocator locatortenantLocator uuidproductName stringstartTime datetimeendTime datetimeduration numberdurationBasis Enum years | months | weeks | days | hoursquoteState Enum draft | validated | earlyUnderwritten | priced | underwritten | accepted | issued | underwrittenBlocked | declined | rejected | refused | discardedunderwritingStatus stringunderwritingFlags UnderwritingFlagResponse[]
GET /policy/{tenantLocator}/quotes/{locator}/underwritingFlags
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:QuoteUnderwritingFlagsResponse
Security Group:quotes  Permission:read
QuoteUnderwritingFlagsResponse
¶requiredquoteLocator locatorflags UnderwritingFlagResponse[]optionalclearedFlags UnderwritingFlagResponse[]?
UnderwritingFlag
¶requiredlocator locatorreferenceLocator locatorlevel Enum info | block | decline | reject | approvereferenceType Enum quote | transactionoptionalelementLocator locator?clearedAt datetime?note string?
PATCH /policy/{tenantLocator}/quotes/{locator}/underwritingFlags
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:UnderwritingFlagsUpdateRequest
Response:QuoteUnderwritingFlagsResponse
Security Group:quotes  Permission:write
UnderwritingFlagsUpdateRequest
¶requiredaddFlags UnderwritingFlagCreateRequest[]clearFlags locator[]
UnderwritingFlagCreateRequest
¶requiredelementLocator locatorlevel Enum info | block | decline | reject | approvenote string
Acceptance
PATCH /policy/{tenantLocator}/quotes/{locator}/accept
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:QuoteResponse
Security Group:quotes  Permission:write
Issuance
PATCH /policy/{tenantLocator}/quotes/{locator}/issue
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:QuoteResponse
Security Group:quotes  Permission:write
Quote Copy and Group Assignment
POST /policy/{tenantLocator}/quotes/{locator}/copy
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:QuoteGroupAssignmentRequest
Response:QuoteResponse
Security Group:quotes  Permission:write
PATCH /policy/{tenantLocator}/quotes/{locator}/assignToGroup
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:QuoteGroupAssignmentRequest
Response:QuoteResponse
Security Group:quotes  Permission:write
QuoteGroupAssignmentRequest
¶requiredgroupLocator locator
GET /policy/{tenantLocator}/quotes/group/{locator}/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
offset | query | int? | optional |
count | query | int? | optional |
extended | query | boolean? | optional |
Response:QuoteListResponse
Security Group:quotes  Permissions:read,list
Static Data
Set the static extension data on a quote
POST /policy/{tenantLocator}/quotes/{locator}/static
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:map<string,object>
Response:QuoteResponse
Security Group:quotes  Permission:write
Updates some of the static data on a quote
PATCH /policy/{tenantLocator}/quotes/{locator}/static
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:StaticDataUpdateRequest
Response:QuoteResponse
Security Group:quotes  Permission:write
StaticDataUpdateRequest
¶requiredremoveData map<string,object>setData map<string,object>
Replaces all of the static data on a quote
PUT /policy/{tenantLocator}/quotes/{locator}/static
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:map<string,object>
Response:QuoteResponse
Security Group:quotes  Permission:write
Documents
GET /document/{tenantLocator}/documents/quote/{locator}/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
offset | query | int? | optional |
count | query | int? | optional |
extended | query | boolean? | optional |
Response:DocumentListResponse
Security Group:documents  Permission:read
DocumentInstanceResponse
¶requiredlocator locatorreferenceLocator locatordocumentInstanceState Enum draft | dataReady | ready | dataError | renderError | conversionErrorexternal booleanreferenceType Enum quote | policy | invoice | transaction | segment | termcreatedAt datetimemetadata map<string,object>renderingData map<string,object>optionalpolicyLocator 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 | zipprocessingErrors string?readyAt datetime?createdBy uuid?
Billing
PATCH /policy/{tenantLocator}/quotes/{locator}/billingLevel
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:UpdateBillingLevelRequest
Response:QuoteResponse
Security Group:quotes  Permission:write
UpdateBillingLevelRequest
¶requiredbillingLevel Enum account | inherit | policy
PATCH /policy/{tenantLocator}/quotes/{locator}/delinquencyPlan
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:DelinquencyPlanUpdateRequest
Response:QuoteResponse
Security Group:quotes  Permission:write
Numbering
GET /policy/{tenantLocator}/quotes/numbers/{quoteNumber}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
quoteNumber | path | string | required |
Response:QuoteResponse[]
Security Group:quotes  Permissions:read,list
POST /policy/{tenantLocator}/quotes/{locator}/number/set
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
quoteNumber | query | string | required |
Response:QuoteResponse
Security Group:quotes  Permission:write
Atypical States and Operations
PATCH /policy/{tenantLocator}/quotes/{locator}/reset
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:ResetOptions
Response:QuoteResponse
Security Group:quotes  Permission:write
ResetOptions
¶requireddeleteAllAutomaticDocuments booleanresetAllUnderwritingFlags booleanresetFlagsAction Enum clear | deletedeleteDocuments locator[]resetFlags locator[]
PATCH /policy/{tenantLocator}/quotes/{locator}/refuse
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:QuoteResponse
Security Group:quotes  Permission:write
PATCH /policy/{tenantLocator}/quotes/{locator}/discard
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:QuoteResponse
Security Group:quotes  Permission:write