Quotes Module API

API reference for quote lifecycle endpoints and full-quote creation helpers.

BriteCore v2 Quotes API endpoint wrappers.

These wrappers cover quote creation and retrieval workflows exposed by the SDK’s current v2 quote surface. The quote paths remain known spec-gap wrappers, so the docstrings describe the intended API contract first and call out SDK-specific response normalization where needed.

britecore_sdk.api.api_calls.v2.quotes.create_full_quote(quote_json, *, client=None, **kwargs)[source]

Create a full quote from the supplied payload.

Uses the configured API client to submit a quote payload and returns both the normalized response body and the created quote ID.

Parameters:

  • quote_json (dict[str, Any]) – Full quote payload dictionary (required).

  • client (BritecoreAPIClient | None) – Optional explicit client override.

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

A tuple of (quote_json, quote_id). Returns (None, None) when the API response is empty after normalization.

Raises:

BritecoreError.MissingParameter – If quote_json is missing or invalid.

Return type:

tuple[dict[str, Any] | None, str | None]

POST /api/v2/quotes/create_full_quote

britecore_sdk.api.api_calls.v2.quotes.get_quote(quote_id, *, client=None, **kwargs)[source]

Retrieve a quote by ID.

Parameters:

  • quote_id (str) – Internal quote ID (required).

  • client (BritecoreAPIClient | None) – Optional explicit client override.

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

Normalized quote response payload.

Raises:

BritecoreError.MissingParameter – If quote_id is missing.

Return type:

Any

POST /api/v2/quotes/get_quote

britecore_sdk.api.api_calls.v2.quotes.associate_agentcy_to_quote(quote_id=None, **kwargs)[source]

Associate an agency with an existing quote.

Parameters:

  • quote_id (Any | None) – Internal quote ID (required).

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

Normalized API response for the association action.

Raises:

BritecoreError.MissingParameter – If quote_id is missing.

Return type:

Any

POST /api/v2/quotes/associate_agentcy_to_quote

britecore_sdk.api.api_calls.v2.quotes.bind_full_quote(external_system_reference=None, id=None, submit_bound=None, **kwargs)[source]

Bind a full quote to a policy.

Either id or external_system_reference must be provided. If both are provided, id takes priority.

Parameters:

  • id (str | None) – The internal quote ID (takes priority if both are provided).

  • external_system_reference (str | None) – The external system reference for the quote.

  • submit_bound (bool | None) – Whether to submit the bound quote immediately (default: False).

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

API response containing the binding confirmation and policy details.

Raises:

BritecoreError.MissingParameter – If neither id nor external_system_reference is provided.

Return type:

Any

Example

>>> bind_full_quote(id="quote-123", submit_bound=True)
>>> bind_full_quote(external_system_reference="EXT-456")

POST /api/v2/quotes/bind_full_quote

britecore_sdk.api.api_calls.v2.quotes.copy_quote(quote_id=None, **kwargs)[source]

Create a copy of an existing quote.

Parameters:

  • quote_id (Any | None) – The internal ID of the quote to copy (required).

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

API response containing the new quote details.

Raises:

BritecoreError.MissingParameter – If quote_id is not provided.

Return type:

Any

Example

>>> copy_quote(quote_id="quote-123")

POST /api/v2/quotes/copy_quote

britecore_sdk.api.api_calls.v2.quotes.create_and_rate_full_quote(quote=None, stateless=None, rate_quote=None, **kwargs)[source]

Create a new quote and rate it in a single operation.

This is a convenience wrapper that combines quote creation and rating, useful for workflows that need an estimated rate immediately.

Parameters:

  • quote (dict[str, Any] | None) – The complete quote payload dictionary (required).

  • rate_quote (bool | None) – Whether to perform rating immediately after creation (default: True).

  • stateless (bool | None) – Whether to use stateless mode for the request (default: False).

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

API response containing the created quote with rating details.

Raises:

BritecoreError.MissingParameter – If quote is not provided or invalid.

Return type:

Any

Example

>>> quote_payload = {"line_type": "...", "insured": {...}, ...}
>>> create_and_rate_full_quote(quote=quote_payload, rate_quote=True)

POST /api/v2/quotes/create_and_rate_full_quote

britecore_sdk.api.api_calls.v2.quotes.create_endorsement_quote(quote_external_system_reference=None, quote_id=None, endorsement_date=None, **kwargs)[source]

Create an endorsement quote from an existing quote.

Either quote_id or quote_external_system_reference must be provided. If both are provided, quote_id takes priority.

Parameters:

  • quote_id (str | None) – The internal quote ID (takes priority if both are provided).

  • quote_external_system_reference (str | None) – The external system reference for the source quote.

  • endorsement_date (str | None) – The effective date for the endorsement (typically ISO 8601 format).

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

API response containing the new endorsement quote details.

Raises:

BritecoreError.MissingParameter – If neither quote_id nor quote_external_system_reference is provided.

Return type:

Any

Example

>>> create_endorsement_quote(quote_id="quote-123", endorsement_date="2024-08-01")
>>> create_endorsement_quote(quote_external_system_reference="EXT-456")

POST /api/v2/quotes/create_endorsement_quote

britecore_sdk.api.api_calls.v2.quotes.create_renewal_quote(external_system_reference=None, quote_id=None, policy_number=None, **kwargs)[source]

Create a renewal quote for an existing policy.

Either quote_id or external_system_reference must be provided if creating from an existing quote. Alternatively, policy_number may be used to create a renewal from a policy directly.

Parameters:

  • quote_id (str | None) – The internal quote ID (priority if both quote identifiers provided).

  • external_system_reference (str | None) – The external system reference for the source quote.

  • policy_number (str | None) – The policy number to renew (used instead of quote identifiers).

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

API response containing the new renewal quote details.

Raises:

BritecoreError.MissingParameter – If no identifying parameters are provided.

Return type:

Any

Example

>>> create_renewal_quote(quote_id="quote-123")
>>> create_renewal_quote(policy_number="POL-456")

POST /api/v2/quotes/create_renewal_quote

britecore_sdk.api.api_calls.v2.quotes.delete_full_quote(external_system_reference=None, id=None, **kwargs)[source]

Delete a full quote by internal ID or external system reference.

Either id or external_system_reference must be provided. If both are provided, id takes priority.

Parameters:

  • id (str | None) – The internal quote ID (takes priority if both are provided).

  • external_system_reference (str | None) – The external system reference for the quote.

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

API response (typically empty on success).

Raises:

BritecoreError.MissingParameter – If neither id nor external_system_reference is provided.

Return type:

Any

Example

>>> delete_full_quote(id="quote-123")
>>> delete_full_quote(external_system_reference="EXT-456")

POST /api/v2/quotes/delete_full_quote

britecore_sdk.api.api_calls.v2.quotes.delete_quote(**kwargs)[source]

Delete a draft quote.

This operation deletes a quote from the system. The quote must be in a draft state (not bound or issued). Use delete_full_quote for more control over which quote to delete.

Parameters:

**kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

API response (typically empty on success).

Return type:

Any

Example

>>> delete_quote()

POST /api/v2/quotes/delete_quote

britecore_sdk.api.api_calls.v2.quotes.get_estimated_quote(rate_quote=None, quote_id=None, stateless=None, **kwargs)[source]

Get an estimated quote with optional rating.

Parameters:

  • quote_id (str | None) – The internal quote ID (required).

  • rate_quote (bool | None) – Whether to perform rating on the quote (default: False).

  • stateless (bool | None) – Whether to use stateless mode for the request (default: False).

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

API response containing the estimated quote details.

Return type:

Any

Example

>>> get_estimated_quote(quote_id="quote-123", rate_quote=True)

POST /api/v2/quotes/get_estimated_quote

britecore_sdk.api.api_calls.v2.quotes.get_quote_properties_summary(quote_id=None, **kwargs)[source]

Get a summary of all properties in a quote.

Parameters:

  • quote_id (Any | None) – The internal quote ID (required).

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

API response containing a list of properties with summary details.

Raises:

BritecoreError.MissingParameter – If quote_id is not provided.

Return type:

Any

Example

>>> get_quote_properties_summary(quote_id="quote-123")

POST /api/v2/quotes/get_quote_properties_summary

britecore_sdk.api.api_calls.v2.quotes.get_quote_wizard_plugin(integration_point_code=None, revision_id=None, integration_instance_id=None, property_id=None, **kwargs)[source]

Retrieve quote wizard plugin output for a revision/property context.

At minimum, callers should provide integration_point_code and revision_id for deterministic behavior.

Parameters:

  • integration_point_code (str | None) – Plugin integration point code.

  • revision_id (str | None) – Revision ID used by the quote wizard plugin.

  • integration_instance_id (str | None) – Optional integration instance ID.

  • property_id (str | None) – Optional property ID context.

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

Normalized plugin payload.

Return type:

Any

POST /api/v2/quotes/get_quote_wizard_plugin

britecore_sdk.api.api_calls.v2.quotes.get_risks(quote_id=None, **kwargs)[source]

Get all risks (properties) associated with a quote.

Returns a list of risks in the quote with their coverage details.

Parameters:

  • quote_id (str | None) – The internal quote ID (required).

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

API response containing a list of risks with coverage details.

Raises:

BritecoreError.MissingParameter – If quote_id is not provided.

Return type:

Any

Example

>>> get_risks(quote_id="quote-123")

POST /api/v2/quotes/get_risks

britecore_sdk.api.api_calls.v2.quotes.issue_full_quote(external_system_reference=None, id=None, **kwargs)[source]

Issue a full quote, making it ready for binding.

Issues a quote which may trigger workflows such as generating documents, sending notifications, or triggering underwriting reviews depending on system configuration.

Either id or external_system_reference must be provided. If both are provided, id takes priority.

Parameters:

  • id (str | None) – The internal quote ID (takes priority if both are provided).

  • external_system_reference (str | None) – The external system reference for the quote.

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

API response containing confirmation of the issued quote.

Raises:

BritecoreError.MissingParameter – If neither id nor external_system_reference is provided.

Return type:

Any

Example

>>> issue_full_quote(id="quote-123")
>>> issue_full_quote(external_system_reference="EXT-456")

POST /api/v2/quotes/issue_full_quote

britecore_sdk.api.api_calls.v2.quotes.list_available_offers(contact_id=None, **kwargs)[source]

List available insurance offers for a contact.

Retrieves a list of products and coverages that can be offered to the contact, based on their profile, location, and risk profile.

Parameters:

  • contact_id (Any | None) – The internal contact ID (required).

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

API response containing a list of available offers with pricing.

Raises:

BritecoreError.MissingParameter – If contact_id is not provided.

Return type:

Any

Example

>>> list_available_offers(contact_id="contact-123")

POST /api/v2/quotes/list_available_offers

britecore_sdk.api.api_calls.v2.quotes.modify_full_quote(messages=None, data=None, success=None, **kwargs)[source]

Modify an existing full quote with updated data.

Updates quote details, coverage selections, or other parameters. This is typically used after retrieving a quote and making modifications before rebinding or rerating.

Parameters:

  • data (Any | dict[str, Any] | None) – The quote data to update (contains modified quote parameters).

  • messages (list[str] | None) – Optional list of messages or notes associated with the modification.

  • success (bool | None) – Indicates whether the modification was successful (typically set by API).

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

API response containing the modified quote details.

Return type:

Any

Example

>>> modify_full_quote(data={"coverage_limits": {...}}, messages=["Updated coverage"])

POST /api/v2/quotes/modify_full_quote

britecore_sdk.api.api_calls.v2.quotes.prefill_loss_history(quote_id=None, **kwargs)[source]

Prefill quote loss history data for the given quote.

Parameters:

  • quote_id (Any | None) – Internal quote ID (required).

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

Normalized prefill response payload.

Raises:

BritecoreError.MissingParameter – If quote_id is missing.

Return type:

Any

POST /api/v2/quotes/prefill_loss_history

britecore_sdk.api.api_calls.v2.quotes.prefill_quote(api_key=None, id=None, **kwargs)[source]

Prefill a quote with data from an external source.

Populates a quote with data from an external system or data provider, such as prior underwriting information or third-party data sources.

Either id or api_key may be required depending on the data source configuration.

Parameters:

  • id (str | None) – The internal quote ID to prefill (required).

  • api_key (str | None) – Optional API key for accessing the data source.

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

API response containing the prefilled quote data.

Return type:

Any

Example

>>> prefill_quote(id="quote-123", api_key="key-456")

POST /api/v2/quotes/prefill_quote

britecore_sdk.api.api_calls.v2.quotes.prefill_violations(quote_id=None, **kwargs)[source]

Prefill violations data for the given quote.

Parameters:

  • quote_id (Any | None) – Internal quote ID (required).

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

Normalized prefill response payload.

Raises:

BritecoreError.MissingParameter – If quote_id is missing.

Return type:

Any

POST /api/v2/quotes/prefill_violations

britecore_sdk.api.api_calls.v2.quotes.rate_full_quote(debug=None, external_system_reference=None, id=None, **kwargs)[source]

Rate a full quote to calculate premiums and coverage options.

Sends a quote to the rating engine to calculate premium rates and available coverage variations. Either id or external_system_reference must be provided. If both are provided, id takes priority.

Parameters:

  • id (str | None) – The internal quote ID (takes priority if both are provided).

  • external_system_reference (str | None) – The external system reference for the quote.

  • debug (bool | None) – Enable debug mode for detailed rating diagnostics (default: False).

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

API response containing rated quote with premium and coverage details.

Raises:

BritecoreError.MissingParameter – If neither id nor external_system_reference is provided.

Return type:

Any

Example

>>> rate_full_quote(id="quote-123", debug=False)
>>> rate_full_quote(external_system_reference="EXT-456")

POST /api/v2/quotes/rate_full_quote

britecore_sdk.api.api_calls.v2.quotes.rate_quote(quote_id=None, **kwargs)[source]

Rate a quote to calculate estimated premiums.

Performs rating on the specified quote. Similar to rate_full_quote but used when only the quote ID is needed.

Parameters:

  • quote_id (Any | None) – The internal quote ID (required).

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

API response containing rated quote with premium details.

Raises:

BritecoreError.MissingParameter – If quote_id is not provided.

Return type:

Any

Example

>>> rate_quote(quote_id="quote-123")

POST /api/v2/quotes/rate_quote

britecore_sdk.api.api_calls.v2.quotes.retrieve_full_quote(external_system_reference=None, id=None, **kwargs)[source]

Retrieve a full quote with all details.

Fetches a complete quote record including coverage details, pricing, underwriting information, and status. Either id or external_system_reference must be provided. If both are provided, id takes priority.

Parameters:

  • id (str | None) – The internal quote ID (takes priority if both are provided).

  • external_system_reference (str | None) – The external system reference for the quote.

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

API response containing the complete quote details.

Raises:

BritecoreError.MissingParameter – If neither id nor external_system_reference is provided.

Return type:

Any

Example

>>> retrieve_full_quote(id="quote-123")
>>> retrieve_full_quote(external_system_reference="EXT-456")

POST /api/v2/quotes/retrieve_full_quote

britecore_sdk.api.api_calls.v2.quotes.submit_application(**kwargs)[source]

Submit the current quote application workflow.

Parameters:

**kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

Normalized submission response payload.

Return type:

Any

POST /api/v2/quotes/submit_application

britecore_sdk.api.api_calls.v2.quotes.submit_change(**kwargs)[source]

Submit a pending quote change workflow.

Parameters:

**kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

Normalized submission response payload.

Return type:

Any

POST /api/v2/quotes/submit_change

britecore_sdk.api.api_calls.v2.quotes.summary(quote_id=None, **kwargs)[source]

Retrieve summary data for a quote.

Parameters:

  • quote_id (Any | None) – Internal quote ID (required).

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

Normalized quote summary payload.

Raises:

BritecoreError.MissingParameter – If quote_id is missing.

Return type:

Any

POST /api/v2/quotes/summary

britecore_sdk.api.api_calls.v2.quotes.turn_quote_into_application(quote_id=None, **kwargs)[source]

Convert a quote record into an application state.

Parameters:

  • quote_id (Any | None) – Internal quote ID (required).

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

Normalized conversion response payload.

Raises:

BritecoreError.MissingParameter – If quote_id is missing.

Return type:

Any

POST /api/v2/quotes/turn_quote_into_application

britecore_sdk.api.api_calls.v2.quotes.update_e_delivery_enabled(revision_id=None, **kwargs)[source]

Update e-delivery settings for a revision.

Parameters:

  • revision_id (Any | None) – Revision ID to update (required).

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

Normalized update response payload.

Raises:

BritecoreError.MissingParameter – If revision_id is missing.

Return type:

Any

POST /api/v2/quotes/update_e_delivery_enabled