policies

Code
Parameters
----------
json_dict : dict
    The json_dict dict have the format
    ::
    {
        'revisionId': '9759c689-72b2-5aef-7579-f90662b583f1',
        'propertyId': '9759c689-72b2-5aef-7579-f90662b583f1',
        'vendor': 'MIB',
        'primaryCoverageId': '',
        'supplements': '',
        'additionalComments': '',
        'reportType': '',
        'specialInstructions': '',
        'commercial': ''
    }

Get dictionary of available primary coverage options with limits.

Code
Parameters
----------
json_dict : dict
    The json_dict dict have the format
    ::
    {
        'propertyId': '9759c689-72b2-5aef-7579-f90662b583f1'
    }

Creates the custom deliverable specified by "deliverableName" and indexes the file in Policies > Attachments.

Code
Parameters
----------
json_dict : dict
    The json_dict dict have the format
    ::
    {
        'revisionId': '9759c689-72b2-5aef-7579-f90662b583f1',
        'deliverableName': 'Declaration',
        'prebuiltHTML': '',
        'generateHTML': 'true'
    }

Given a zip code and a business state, looks up and returns the Cities and Counties related to that Zip Code as determined by the Geography table, and a flag to determine if the zip code is valid in our data set. Counties are then cross-referenced with business locations

Code
Parameters
----------
json_dict : dict
    The json_dict dict have the format
    ::
    {
        'stateAbbr': 'MA',
        'zip': '01915',
        'propId': '9759c689-72b2-5aef-7579-f90662b583f1'
    }

Mark a payment as having non-sufficient funds; debit or waive NSF fee; allow or postpone canceling a policy.

Code
Parameters
----------
json_dict : dict
    The json_dict dict have the format
    ::
    {
        'paymentId': '9759c689-72b2-5aef-7579-f90662b583f1',
        'dueMonth': '04',
        'dueDay': '15',
        'dueYear': '2020',
        'assessFee': '100.00',
        'allowCancel': 'false',
        'policyId': '7949c689-42b2-4aef-8579-e70662b582e6',
    }

Receives a list of external_policy dictionaries and assigns it to the included policy_group_id.

Code
Parameters
----------
external_policies : list
    A list with the form:
    ::
        [
            {
                policy_id: uuid,
                policy_group_id: uuid
            },
            ...
        ]

Returns
-------
success : bool
messages : list
    The sql error if one occurs, or a success message.

Adds a Line Item to a revision/property.

Code
Parameters
----------
revision_id : UUID, required
    The UUID of an existing Revision
property_id : UUID, optional
    The UUID of an existing Property. Only needed for line items with property category
sub_line_id : UUID, optional
    The UUID of an existing SubLine. Only needed if adding to an existing subline.
item_id : UUID, required
        The UUID of an existing Item
link_id : UUID, optional
    The UUID of an existing link. Only needed if being added by another
     item's Underwriting Rules.
check_for_sub_line : bool
    defaults to False, Set this to true if this item belongs in a
     subline that may not exist yet.

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    The data response having the form:
    ::
        {
            'added_items': [
                {
                    'id': UUID,
                    'property_id': UUID,  # Only if this is a property item
                    'revision_id': UUID,  # Only if this is a revision item
                    'sub_line_instance_id': UUID,  # Only if this is on a sub line
                    'item_id': UUID,
                    'apply_date': date,
                    'limit': Decimal('0.00'),
                    'deductible': Decimal('0.00'),
                    'written_premium': Decimal('0.00'),
                    'annual_premium': Decimal('0.00'),
                    'written_fee': Decimal('0.00'),
                    'annual_fee': Decimal('0.00'),
                    'manual': bool,
                    'loss_exposure_group': int,
                    'builder_obj': {},
                    'link_obj: {},
                    'rating_details: {},
                    'date_added': date,
                    'date_added_micro': str (microseconds),
                    'prev_adj_amt': Decimal('0.00')
                    'persist_status': ('normal', 'copied', 'conflicted', 'rejected', 'resolved')
                    'resolved': bool,
                    'status_reason': str,
                    'allow_multiples': bool,
                    'category': ('policy', 'property'),
                    'description': str,
                    'limit_availability': str,
                    'mandatory': bool,
                    'name': str,
                    'show_in_builder': bool,
                    'sort_order': int,
                    'type': ('coverage', 'adjustment', 'nonRate',
                             'fee', 'calculation', 'dividend')
                }, ...
            ],
            'added_subline': {
                ...
            }
        }

Receives a list of policy dictionaries and assigns it to the given policy_group_id.

Code
Parameters
----------
policies : list
    A list with the form:
    ::
        [
            {
                policy_id: uuid,
                policy_group_id: uuid
            },
        ]
Returns
-------
success : bool
messages : list
    the sql error if one occurs, or a success message.

Receives a list of policy dictionary lists and adds each element to a policy group.

Code
Parameters
----------
policies : list
    A list with the form:
    ::
        [
            [
                {
                    policy_id: uuid,
                    external_policy: bool(optional key)
                },
                ...
            ],
            ...
        ]

Returns
-------
success : bool
messages : list
    The sql error if one occurs, or a success message.

Adds a Sub Line to a revision/property.

Code
Parameters
----------
revision_id : UUID, required
    The UUID of an existing Revision
property_id : UUID, optional
    The UUID of an existing Property
sub_line_id : UUID, required
    The UUID of an existing SubLine
link_id : UUID, required
    (optional) The UUID of an existing Link. Only needed if being added by another
     item's Underwriting Rules

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    The data response having the form:
    ::

        {
            'id': UUID,
            'property_id': UUID,  # Only if this is a property sub line
            'revision_id': UUID,  # Only if this is a revision sub line
            'sub_line_id': UUID,
            'inheritance_id': UUID,
            'date_added': date,
            'date_added_micro': str (microseconds),
            'category': ('policy', 'property'),
            'default': bool,
            'mandatory': bool,
            'allow_multiples': bool,
            'name': str,
            'policy_type_id': UUID,
            'sort_order': int,
            'description': str,
            'type': ('liability', 'inland marine', 'property'),
            'persist_status': ('normal', 'copied', 'conflicted', 'rejected', 'resolved')
            'resolved': bool,
            'status_reason': str
        }

Triggers processing for a created, signed, canceled or signed-by-all Policy Application.

Code
Parameters
----------
policy_id : str
    Policy Id of the application associated with the signature.
signer_name : str
    The name of the contact who signed this Policy Application.
signature_url : str
    An URL where the signed document can view reviewed.
event_type : str
    The event type (created, signed, all_signed, or canceled).
file_id : str

Returns
-------
success : bool
    True if successful, False if not
message : str
    'Event processed' if successful, else human-readable error message
data : None

Applies a collection of transaction records as accounted BriteCore payments.

Code
Parameters
----------
transactions : list of dict
    Iterable containing dicts of the following format:
    ::
        {
            # Reference to an existing policy number, cleared of
            # non-numerical characters (ex: the policy "P90-2010-8" would
            # be represented here as "9020108")
            "policy": str,

            # Code identifying the check to be processed.
            "check": str,

            # The amount to be payed (with precision: 0.00).
            "payment": decimal.Decimal,
        }

Returns
-------
success : bool
messages : list of strings
    List of human readable error messages filled only when success != True.
data : list of dict
    A list of dicts, containing the results of the individual attempts to
    apply the payment transactions. The result list is aligned to the input
    transactions list, meaning it is possible to zip(transactions, results)
    to analyze the results in respect to its input. Each contained element
    has the following format:
    ::

        {
            # Either "success" when the respective payment was correctly
            # applied or "error" when it was not.
            "result": str,

            # A human readable message detailing the result field in case its
            # value is different from "success".
            "detail": str
        }

async_create_policy_from_britequote

async_create_revision_from_britequote

Asynchronous request of loss analysis

Code
Parameters
----------
revision_id : str
    The UUID of an existing Revision

Returns
-------
data : dict
    The data response having the form:
    ::
        {
            'job_id'  uuid: ID of the async task
        }

Bind a policy from the API

Code
Parameters
----------
bind_info : dict
    A list with the form:
    ::
        {
            "policy_number": "10-2017-1001",
            "policy_id": "0fe6a7bf-bca7-4757-825c-7cc9bf90cfc0"
        }

Returns
-------
success : bool
    True if successful, False if not
message : list of str
    Human-readable messages with error.
data : dict
    Description of response dictionary here.

Code
DEPRECATED: This function is deprecated and will be removed in a future version.
Please use cancel_policy_v2 instead, which provides enhanced validation,
error handling, and consistent response formatting.

API v2 wrapper around lib.policies.views:cancelPolicy.

Note that the underlying cancelPolicy() has the following side-effects:
- policy_accounting.update_invoice_print_state
- creates revision row for U(policy_id, policy_term_id) with policyStatusReasonID set to cancellation_reason_id and cancel date
- updates cancelDate of other future committed revisions for this U(policy_id, policy_term_id)
- creates account_history row
- create_deliverable()
- make_note()

Parameters
----------
policy_id : str
    The UUID of an existing policy
policy_term_id : str
    The UUID of an existing policy term
cancel_reason_id : str
    The UUID of an existing cancel reason
    If this is passed in, cancel_reason does not have to be. If both are specified, then cancel_reason
    will be ignored since it is less accurate than the cancel_reason_id.
cancel_date : str
    A string representing the cancel date ("YYYY-MM-DD").
    If cancel_pending_date is specified, that will take precendence over cancel_date.
cancel_pending_date : str
    A string representing the cancellation pending date ("YYYY-MM-DD").
    If this is specified, put the policy into cancellation pending instead of canceling immediately.
cancel_reason : str
    A string representing the cancellation reason.
    This can be used in place of the cancel_reason_id. If this is passed in, cancel_reason_id does not have to be.
    If the cancel_reason_id is passed in then this will be ignored as it is less accurate. Passing in the
    cancel_reason_id is the preferred and recommended method.

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    The data response having the form:
    ::
        {
            "success": bool,
            "message": str
        }

Code
Enhanced API v2 endpoint for policy cancellation with comprehensive validation and error handling.

This function provides a modern interface for policy cancellation with:
- Comprehensive input validation
- Idempotency support
- Standardized error handling
- Enhanced response formatting
- Business rule validation

Parameters
----------
request_params : dict
    Dictionary containing cancellation parameters
Returns
-------
dict
    Standardized response with the following structure:
    ::
        {
            "success": bool,
            "messages": list of str,
            "data": {
                "policy_id": str,
                "policy_term_id": str,
                "cancellation_date": str,
                "cancellation_pending_date": str,
                "cancellation_reason": {
                    "id": str,
                    "name": str
                },
                "revision_id": str,
                "policy_number": str,
                "policy_status": str,
                "print_description": str,
                "additional_description": str
            }
        }

Raises
------
BCServiceError
    If validation or business rules are violated
Exception
    For system errors

Copies risk information from one risk to another.

Code
Parameters
----------
from_risk_id : UUID, required
to_risk_id : UUID, required
copy_address : Optionally copies the address from (from_risk_id) to (to_risk_id), DEFAULT: True
copy_rating : Optionally copies the rating from (from_risk_id) to (to_risk_id), DEFAULT: True
copy_mortgagees : Optionally copies the mortgagees from (from_risk_id) to (to_risk_id), DEFAULT: False
copy_tenants : Optionally copies the tenants from (from_risk_id) to (to_risk_id), DEFAULT: False
copy_additional_interests : Optionally copies building-level additional interests from (from_risk_id) to (to_risk_id), DEFAULT: True

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    *see retrieve_risk_details*

Adds copy of a Sub Line to a revision/property.

Code
Parameters
----------
revision_id : UUID, required
    The UUID of an existing Revision
property_id : UUID, optional
    The UUID of an existing Property
sub_line_id : UUID, required
    The UUID of an existing SubLine
sub_line_instance_id: UUID, required
    The UUID of an existing SubLineInstance
link_id : UUID, required
    (optional) The UUID of an existing Link. Only needed if being added by another
     item's Underwriting Rules

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    The data response having the form:
    ::

        {
            'id': UUID,
            'property_id': UUID,  # Only if this is a property sub line
            'revision_id': UUID,  # Only if this is a revision sub line
            'sub_line_id': UUID,
            'inheritance_id': UUID,
            'date_added': date,
            'date_added_micro': str (microseconds),
            'category': ('policy', 'property'),
            'default': bool,
            'mandatory': bool,
            'allow_multiples': bool,
            'name': str,
            'policy_type_id': UUID,
            'sort_order': int,
            'description': str,
            'type': ('liability', 'inland marine', 'property'),
            'persist_status': ('normal', 'copied', 'conflicted', 'rejected', 'resolved')
            'resolved': bool,
            'status_reason': str
        }

create_from_stateless_quote

Create a new loss dispute record

Code
Parameters
----------
property_id : UUID
case_number : string
reason : text

Returns
-------
success : bool
    True if successful, False if not
message : list of str
    Human-readable messages with error.
data: dict of newly created loss_dispute

Create a new policy from the API as part of the create_quote logic.

Create a new policy from the API as part of the create_quote_extended logic.

Code
This function is responsible for creating a new policy from the API as part of the create_quote_extended logic.
It is responsible for formatting the underwriting options and questions, and for creating the policy.

Returns
-------
dict
    A dictionary containing the new policy data.

Raises
------
Exception
    If an error occurs while creating the policy.
    Returns a standard error response.

Creates a new policy.

Code
Parameters
----------
policy_number : str
    defaults to the next system generated policy number
inception_date : str
    defaults to today
term_type : str
    ('Custom', '3 Years', '18 Months', '1 Year', '9 Months', '6 Months', '3 Months')
expiration_date : str
    (optional) - required if term_type is 'Custom'
renewal_term_type : str
    ('3 Years', '18 Months', '1 Year', '9 Months', '6 Months', '3 Months')
is_renewal : bool
    (optional) if the policy should be processed as a renewal
underwriting_questions : list
    (optional) if enforcing underwriting questions
underwriting_options : list
    (optional) if enforcing underwriting options
as_agent : bool
    If true, creator and agent relations are based on logged in user
    It also adds a meta key in the response that holds the redirect_uri location
    of the new quote.
manual_policy_number : bool
    indicates whether the policy number was manually assigned
policy_type_id : uuid
    (optional): Given a policy type ID, the policy type is attached to the revision
effective_date : str
    (optional) - required if effective_date is different than inception_date. Defaults to inception date
external_system_reference : str
property_zip : str
    (optional) - used to determine if there are suspensions for this zip code.
save_policy_type : boolean
    (optional): If true, and policy_type_id is passed, the policy type is attached to the revision

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    The data response having the form:
    ::

        {'policy_id': UUID,
         'revision_id': UUID,
         'policy_term_id': UUID,
         'policy_number': str, (System generated number if none provided)
         'revision_data': {*see retrieve_revision_details*}
         'policy_contacts' : {}}

Code
Creates a Policy from a BriteQuote unified risk state object.

Parameters
----------
quote : dict
    A quote externally rated from containing data such as all risks, fields, items, and premiums.
inception_date: Date
    With the following format: %Y-%m-%d
term_type: string
    "1 Year" for instance
transaction_type: string
    "new_business" by default, but it can also be "rewrite"
postback: dict
        Data sent from a third party system to be used based on the transaction type

Create a quote from the API

Code
Parameters
----------
quote_info : dict
    A object with the form:
    ::
        {
            "underwriting_questions": [
                {
                    "questionId": "UUID-1",
                    "yesNoAnswer": "no",
                    "explanation": ""
                },
                {
                    "questionId": "UUID-2",
                    "yesNoAnswer": "no",
                    "explanation": ""
                }
            ],
            "named_insured": "My Software Company, Inc.",
            "named_insured_type": "organization",
            "named_insured_address":
            {
                "address_line1": "30 Marion Ave",
                "address_line2": "",
                "address_city": "Albany",
                "address_state": "NY",
                "address_county": "Albany",
                "address_country": "USA",
                "address_zip": "12203",
                "latitude": 42.6652464,
                "longitude": -73.80048369999997
            },
            "website": "www.test.com",
            "line_name": "Worker's Compensation",
            "policy_type_name": "Workers' Compensation",
            "effective_date": "10/26/2017",
            "agency_id": "<agency_id>",
            "agent_id": "<agent_id>",
            "activated": false,
            "locations": [
                {
                    "address_line1": "30 Marion Ave",
                    "address_line2": "",
                    "address_city": "Albany",
                    "address_state": "NY",
                    "address_county": "Albany",
                    "address_county_specify": "",
                    "address_country": "USA",
                    "address_zip": "12203",
                    "latitude": 42.6652464,
                    "longitude": -73.80048369999997
                }
            ],
            "items": [
                {
                    "name": "Policy Information",
                    "questions": {
                        "Market Segment": "",
                        "Standard Industrial Classification (SIC)":
                            "7371 Computer Programming Services",
                        "Each Accident Limit/Disease-Policy Limit/Disease-Each Employee Limit":
                            "$500,000/$500,000/$500,000"
                    }
                },
                {
                    "name": "Class Code",
                    "questions":
                    {
                        "Payroll Amount": "100000",
                        "# Full Time Employees": "1",
                        "# Part Time Employees": "",
                        "Occupation": "8810 Clerical Office Employees NOC",
                        "If Any": "No"
                    }
                },
                {
                    "name": "Coverage A",
                    "limit": 100000
                }
            ],
            "soft_geoservice_bypass": False,
            "hard_geoservice_bypass": False
        }

Returns
-------
success : bool
    True if successful, False if not
message : list of str
    Human-readable messages with error.
data : dict
    ::
        {
            "quote_number": "Quote-2017-0000001",
            "policy_id": "POLICY-UUID",
            "total": {
                "pro_rata_fees": 69.00,
                "pro_rata_premium": 861.00,
                "pro_rata_total": 930.00,
                "annual_fees": 69.00,
                "annual_premium": 861.00,
                "annual_total": 930.00
            },
            "items": [
                {
                    "name": "Policy Information",
                    "pro_rata_amount": 0.00,
                    "annual_amount": 0.00
                },
                {
                    "name": "Class Code",
                    "pro_rata_amount": 861.00,
                    "annual_amount": 861.00
                }
            ]
        }

Create a quote as a background job from the API

Code
Parameters
----------
quote_info : dict
    A object with the form:
    ::
        {
            "api_key": "<your_api_key>",
            "quote_info": {
                "named_insured": "BC Test OCT2",
                "named_insured_type": "organization",
                "named_insured_address": {
                    "address_line1": "123 Mission St",
                    "address_line2": "",
                    "address_city": "San Francisco",
                    "address_state": "CA",
                    "address_county": "",
                    "address_county_specify": "",
                    "address_country": "USA",
                    "address_zip": "94105"
                },
                "line_name": "Cyber Liability",
                "policy_type_name": "HSB Total Cyber",
                "effective_date": "07/07/2021",
                "agency_id": "<agency_id>",
                "agent_id": "<agent_id>",
                "locations": [
                    {
                        "address_line1": "123 Mission St",
                        "address_line2": "",
                        "address_city": "San Francisco",
                        "address_state": "CA",
                        "address_county": "",
                        "address_county_specify": "",
                        "address_country": "USA",
                        "address_zip": "94105"
                    }
                ],
                "items": [
                    {
                        "name": "Rating Information",
                        "limit": 4000000,
                        "questions": {
                            "Retroactive Date (MM/DD/YYYY)": "",
                            "Industry Category": "62 - Health Care and Social Assistance",
                            "Annual Revenue / Operating Revenue": "3000000"
                        }
                    }
                ]
            }
        }
Returns
-------
success : bool
    True if successful, False if not
message : list of str
    Human-readable messages with error.
data : dict
    ::
        {
            "quote_number": "Q2021000078",
            "policy_id": "<policy_id>"
        }

Create a new quote using the API.

Code
- Advanced settings `application-future-date-bound` and `application-past-date-bound` will be
  enforced if the API key used is not associated with an "Administrator" contact.

``log_api_payloads`` logs the request payload and response body at INFO,
matching ``create_and_rate_full_quote``.

run_uw_rules : bool
    Run Underwriting Rules and calculate limits of Property Items.
    If run_stateless, this will be ignored, as Underwriting Rules are always run in stateless mode.
run_stateless : Union[bool, 'debug']
    If true, run the quote in stateless mode. This will create a stateless_quote_id in response.
    If "debug", it will run the quote and include execution details, but NOT create a stateless_quote_id.
    If false (default), the quote will be stored in the database and a policy number/ID is returned.
requote : bool
    Only works when run_stateless is false.
quote_info : dict:
    A dict having the form:
    ::
        {
            "policy_number": "optional manual policy number",
            "inception_date": "MM/DD/YYYY" (optional),
            "effective_date": "MM/DD/YYYY",
            "line_name": "line name",
            "is_renewal": boolean, // optional, default is false
            "policy_type_name": "policy type name",
            "underwriting_options": [{
                "answer": "answer",
                "optionId": "option id"
            }],
            "underwriting_questions": [{
                // Either questionId or questionText is required.
                "questionId": "question id",  // UUID; precise but changes per
                                              // policy-type effective date.
                "questionText": "text fragment",  // case-insensitive contains
                                                  // match on the question's
                                                  // yes_no_question text,
                                                  // scoped to this policy
                                                  // type's effective version.
                                                  // Must match exactly one.
                "yesNoAnswer": "no",
                "explanation": "explanation"
            }],
            "named_insureds": [{
                "name": "name",
                "type": "organization",
                "fein_tax": "1234567",
                "ssn": "001112222",
                "date_business_started": "MM/DD/YYYY", // optional
                "website": "www.test.com",
                "legal_entity_type": "legal entity type", // optional
                "phones": [{ // optional
                    "number": "1234567890",
                    "type": "work"
                }],
                "emails": [{ // optional
                    "email": "test@example.com",
                    "type": "work"
                }],
                "addresses": [
                    {
                        "address_line1": "address line 1",
                        "address_line2": "",
                        "address_city": "city",
                        "address_state": "NY",
                        "address_county": "county",
                        "address_country": "USA",
                        "address_zip": "12208",
                        "type": "Mailing"
                    }
                ],
                "retrieve_credit_report": false,      // optional
                "retrieve_credit_report_timeout": 30  // optional
            }],
            "additional_interests": [{  // optional
                "Interest": "Interest in property",
                "name": "name",
                "type": "organization",
                "fein_tax": "1234567",
                "ssn": "001112222",
                "date_business_started": "MM/DD/YYYY", // optional
                "legal_entity_type": "legal entity type", // optional
                "phones": [{ // optional
                    "number": "1234567890",
                    "type": "work"
                }],
                "emails": [{ // optional
                    "email": "test@example.com",
                    "type": "work"
                }],
                "addresses": [
                    {
                        "address_line1": "address line 1",
                        "address_line2": "",
                        "address_city": "city",
                        "address_state": "NY",
                        "address_county": "county",
                        "address_country": "USA",
                        "address_zip": "12208",
                        "type": "Mailing"
                    }
                ]
            }],
            // At least one of "agency_id" or "agency_number" is required.
            // agency_number takes precedence if both are present.
            "agency_id": "uuid",  // conditionally optional; see note above
            "agency_number": str,  // conditionally optional; see note above
            // At least one of "agent_id" or "agent_number" is required.
            // agent_number takes precedence if both are present.
            "agent_id": "uuid", // conditionally optional; see note above
            "agent_number": str,  // conditionally optional; see note above
            "locations": [{
                "address_county_specify": "",
                "address_line1": "address line 1",
                "address_line2": "",
                "address_city": "city",
                "address_state": "NY",
                "address_county": "county",
                "address_country": "USA",
                "address_zip": "12208",
                "primary": true
            }],
            // `items` accepts EITHER a list (below) OR an object keyed by
            // item name -- {"<name>": {..} } or, for allow_multiples items,
            // {"<name>": [{..}, {..}]}. Object-keyed input is normalized to
            // this list form before processing; the object form is the
            // canonical, schema-targetable shape (io_mapping workbench).
            "items": [{
                "name": "name",
                "questions": {
                    "question 1": "answer 1",
                    "question 2": "answer 2",
                },
                "rating_details": ["rating_detail_type"], // optional
                "identifier": "question 1", // optional
                "sub_line": "sub line name" // optional
            }],
            "activated": false,
            "soft_geoservice_bypass": false,
            "hard_geoservice_bypass": false
        }
        or
        {
            // Populate a quote from a saved stateless quote ID.
            "stateless_quote_id": "stateless quote id",
            "activated": false,
            "soft_geoservice_bypass": false,
            "hard_geoservice_bypass": false
        }

Returns
-------
success : bool
    True if successful, False if not
message : list of str
    Human-readable messages with error.
    If credit report retrieval on any named insured has failed, the message list will contain the message
    "Credit vendor failed", as well as any detailed error message.
data : dict
    A dict having the form:
    ::
    {
        "quote_number": "quote number",  // Only when run_stateless is false
        "stateless_quote_id": "stateless quote id",  // Only when run_stateless is true
        "items": [{
            "annual_amount": 0.0,
            "name": "item name",
            "pro_rata_amount": 0.0,
            "rating_details": [{"rating_detail_type": running_total}]
            "identifier": "identifier if the optional parameter is given"  // Only when run_stateless is false
        }],
        "total": {
            "annual_fees": 0.0,
            "pro_rata_premium": 0.0,
            "annual_total": 0.0,
            "pro_rata_total": 0.0,
            "annual_premium": 0.0,
            "pro_rata_fees": 0.0
        },
        "forms": [{  // Only when run_stateless is false
            "edition_number": "edition number",
            "description": "form description",
            "form_code": "form code"
        }],
        "policy_id": "policy id",  // Only when run_stateless is false
        "policy_type_id": "policy type id",  // Only when run_stateless is false
        "primary_property_id": "primary property id",  // Only when run_stateless is false
        "revision_id": "revision id",  // Only when run_stateless is false
        "stp": {  // Only when run_stateless is false
            "ran": true,
            "success": true,
            "details": []
        }
    }

Create a quote as a background job from the API. This shares functionality with the 'create_quote_extended' endpoint.

Code
- Advanced settings `application-future-date-bound` and `application-past-date-bound` will be
  enforced if the API key used is not associated with an "Administrator" contact.

Parameters
----------

run_uw_rules : bool
    Run Underwriting Rules and calculate limits of Property Items
quote_info : dict
    A object with the form:
    ::
        {
            "api_key": "<your_api_key>",
            "quote_info": {
                "named_insured": "BC Test OCT2",
                "named_insured_type": "organization",
                "named_insured_address": {
                    "address_line1": "123 Mission St",
                    "address_line2": "",
                    "address_city": "San Francisco",
                    "address_state": "CA",
                    "address_county": "",
                    "address_county_specify": "",
                    "address_country": "USA",
                    "address_zip": "94105"
                },
                "line_name": "Cyber Liability",
                "is_renewal": boolean, // optional, default is false
                "policy_type_name": "HSB Total Cyber",
                "inception_date": "07/07/2021" (optional),
                "effective_date": "07/07/2021",
                // At least one of "agency_id" or "agency_number" is required.
                // agency_number takes precedence if both are present.
                "agency_id": "<agency_id>",  // conditionally optional; see note above
                "agent_id": "<agent_id>",  // conditionally optional; see note above
                "locations": [
                    {
                        "address_line1": "123 Mission St",
                        "address_line2": "",
                        "address_city": "San Francisco",
                        "address_state": "CA",
                        "address_county": "",
                        "address_county_specify": "",
                        "address_country": "USA",
                        "address_zip": "94105"
                    }
                ],
                "items": [
                    {
                        "name": "Rating Information",
                        "limit": 4000000,
                        "questions": {
                            "Retroactive Date (MM/DD/YYYY)": "",
                            "Industry Category": "62 - Health Care and Social Assistance",
                            "Annual Revenue / Operating Revenue": "3000000"
                        }
                    }
                ]
            }
        }
Returns
-------
success : bool
    True if successful, False if not
message : list of str
    Human-readable messages with error.
data : dict
    ::
        {
            "quote_number": "Q2021000078",
            "policy_id": "<policy_id>"
        }

Code
Parameters
----------
quote: dict, required
        Endorsement dict from BriteQuote
revision_date: str, required
        'YYYY-dd-MM' formatted string stating the new revision's start date
policy_id: str, required
        Policy id to create a new revision
transaction_type: str, required
        Tell which transaction will be executed by Gen 2 (e.g. 'cancellation')
postback: dict
        Data sent from a third party system to be used based on the transaction type. It's
        required when transaction_type is equals to 'cancellation' or 'reinstatement'

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data: dict
    The data response if success is True
    ::
        {
            'policy_id': str
            'revision_id': str
            'policy_number': str
            'redirect_uri': str
        }
    The data response if success is False
    ::
        {
            'success': bool
            'messages': [str]
        }

Creates a new risk (property) for the given revision.

Code
Parameters
----------
revision_id : str, required
property_group_number : int
building_number : int
force_categories : bool, optional
    If True, forces category creation for mandatory items

Returns
-------
success: bool
    True if successful, false if not
messages: list of str
    List of human-readable error messages
data:
    The data response having the form:
    ::

        {
            'id': UUID,
            'revision_id': UUID,
            'name': str ("Property #"),
            'address_state': str ("MO"),
            'property_group_id': UUID
        }

Receives a list of external policies to be deleted.

Code
Parameters
----------
policies : list
    A list of policy numbers:

Returns
-------
success : bool
messages : list of str
data : list of external policy numbers(if an exception is raised)

Mark a loss_dispute as deleted This is not going to delete the db register, but set the dispute as deleted Parameters ---------- dispute_id : UUID Returns ------- success : bool True if successful, False if not message : list of str Human-readable messages with error.

Run non pay cancellation evaluation logic for a given policy

Code
Parameters
----------
policy_id : str
    The UUID of the policy to evaluate for cancellation

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    The data response having the form:
    ::
        {
            "success": bool,
            "cancel": bool,
            "np_created": bool,
        }

Code
Retrieve all data points specific to policies for the given revision ids.

Parameters
----------
revision_ids : list of str, required
    List of revision ids to generate data points for policies
property_ids : list of str, optional
    List of property ids to filter results

Notes
-----
Every return premium of the policy is listed under
``revision.policy_term.billing.return_premiums``, sorted from newest to
oldest, so ``return_premiums[0]`` is always the most recent return premium.
Return premium dates carry no time of day, so same-day return premiums are
ordered by when the underlying account history entry was raised.

Returns
-------
success : bool
    True if successful, false if not
message : list of str
    Human-readable messages.
data :
    Contains the data points of the policy in the following format:
[
    {
        "revision": {
            "id": ,
            "policy_id": ,
            "policy_term_id": ,
            "cancel_date": ,
            "commission_rate": ,
            "commission_rate_adjustment": ,
            "commit_date": ,
            "commit_date_time": ,
            "create_date": ,
            "date_archived": ,
            "dec_description": ,
            "description": ,
            "written_fee": ,
            "grant_mortgagee_extension": ,
            "override_commission": ,
            "policy_status": ,
            "policy_status_reason_id": ,
            "policy_type_id": ,
            "written_premium": ,
            "print_dec": ,
            "reinstate_at_commit": ,
            "revision_date": ,
            "revision_state": ,
            "annual_fee": ,
            "annual_premium": ,
            "underwriting_questions": ,
            "underwriting_contacted": ,
            "underwriting_contact_date": ,
            "builder_pending": ,
            "deleted": ,
            "credit_report_permissions": ,
            "date_updated": ,
            "last_visited": ,
            "builder_ready_to_rate": ,
            "review_workflow_state": ,
            "signature_type": ,
            "review_workflow_request_reason": ,
            "underwriting_options": ,
            "primary_property_id": ,
            "written_premium_delta": ,
            "cancellation_revision_id": ,
            "previous_revision_state": ,
            "overpayment": ,
            "coverages": [
                {
                    "revision_item_id": ,
                    "revision_id": ,
                    "sub_line_instance_id": ,
                    "item_id": ,
                    "apply_date": ,
                    "limit": ,
                    "limit_type": ,
                    "limit2_type": ,
                    "limit3_type": ,
                    "limit2": ,
                    "limit3": ,
                    "deductible": ,
                    "written_premium": ,
                    "annual_premium": ,
                    "written_fee": ,
                    "annual_fee": ,
                    "manual": ,
                    "loss_exposure_group": ,
                    "builder_obj": ,
                    "link_obj": ,
                    "rating_details": ,
                    "date_added": ,
                    "date_added_micro": ,
                    "deleted": ,
                    "date_deleted": ,
                    "deleted_by": ,
                    "prev_adj_amt": ,
                    "persist_status": ,
                    "resolved": ,
                    "status_reason": ,
                    "date_updated": ,
                    "limit_updated": ,
                    "previous_id": ,
                }
            ],
            "risks": {
                "vehicles": [
                    {
                        "id",
                        "revision_id": ,
                        "address_accuracy": ,
                        "address_city": ,
                        "address_county": ,
                        "address_line_1": ,
                        "address_line_2": ,
                        "address_state": ,
                        "address_country": ,
                        "address_zip": ,
                        "copy_address": ,
                        "county_specify": ,
                        "date_added": ,
                        "date_added_micro": ,
                        "deleted": ,
                        "fire_district_distance": ,
                        "flag": ,
                        "gross_area": ,
                        "hydrant_distance": ,
                        "inspection_requested_date": ,
                        "inspection_vendor": ,
                        "latitude": ,
                        "longitude": ,
                        "loss_history_report_content": ,
                        "loss_history_report_number": ,
                        "name": ,
                        "next_inspection_date": ,
                        "property_val": ,
                        "protection_class_id": ,
                        "iso_pc_data": ,
                        "verisk_passport_data": ,
                        "prefill_services_data": ,
                        "replace_contents": ,
                        "replace_loss": ,
                        "replace_other": ,
                        "replacement_cost_value": ,
                        "approved_limits": ,
                        "stories": ,
                        "type": ,
                        "year_built": ,
                        "annual_fee": ,
                        "annual_premium": ,
                        "written_fee": ,
                        "written_premium": ,
                        "date_updated": ,
                        "risk_data": ,
                        "builder_ready_to_rate": ,
                        "property_group_id": ,
                        "previous_id": ,
                        "location_number": ,
                        "vehicle_year": ,
                        "vehicle_make": ,
                        "vehicle_model": ,
                        "vehicle_vin": ,
                        "vehicle_body_type": ,
                        "new_vehicle": ,
                        "cost_new_vehicle": ,
                        "performance": ,
                        "date_vehicle_leased": ,
                        "date_vehicle_purchased": ,
                        "miles_to_work": ,
                        "per_week_days_driven": ,
                        "per_month_weeks_driven": ,
                        "usage": ,
                        "multi_car": ,
                        "car_pool": ,
                        "air_bags": ,
                        "anti_lock_brakes": ,
                        "anti_theft_device": ,
                        "symbol_age_group": ,
                        "symbol_collision": ,
                        "symbol_comprehensive": ,
                        "symbol_liability": ,
                        "symbol_medical_payments": ,
                        "territory": ,
                        "horse_power": ,
                        "vehicle_class": ,
                        "vehicle_type": ,
                        "owned_or_leased": ,
                        "annual_mileage": ,
                        "odometer_reading": ,
                        "seat_belts": ,
                        "seat_belt_type": ,
                        "air_bag_type": ,
                        "anti_theft_code": ,
                        "anti_theft_device_type": ,
                        "registered_state": ,
                        "garage_code": ,
                        "customized_equipment": ,
                        "used_for_ride_share": ,
                        "daytime_running_lights": ,
                        "gross_vehicle_weight": ,
                        "purchased_new": ,
                        "acres": ,
                        "legal_description": ,
                        "plate_number": ,
                        "coverages": [
                            {
                                "id": ,
                                "property_id": ,
                                "sub_line_instance_id": ,
                                "item_id": ,
                                "apply_date": ,
                                "limit": ,
                                "limit_type": ,
                                "limit_3_type": ,
                                "limit_2_type": ,
                                "limit_2": ,
                                "limit_3": ,
                                "deductible": ,
                                "written_premium": ,
                                "annual_premium": ,
                                "written_fee": ,
                                "annual_fee": ,
                                "manual": ,
                                "loss_exposure_group": ,
                                "builder_obj": ,
                                "link_obj": ,
                                "rating_details": ,
                                "date_added": ,
                                "date_added_micro": ,
                                "deleted": ,
                                "date_deleted": ,
                                "deleted_by": ,
                                "prev_adj_amt": ,
                                "persist_status": ,
                                "resolved": ,
                                "status_reason": ,
                                "date_updated": ,
                                "limit_updated": ,
                                "previous_id": ,
                            }
                        ],
                        "additional_interests": [
                            {
                                "id": ,
                                "property_id": ,
                                "contact_id": ,
                                "mortgagee": ,
                                "inspector": ,
                                "description": ,
                                "loan_num": ,
                                "type": ,
                                "date_added": ,
                                "dec_mort_statement": ,
                                "date_updated": ,
                                "driver": ,
                                "tenant": ,
                            }
                        ],
                    }
                ],
                "properties": [
                    ...
                ],
            },
            "policy_term": {
                "id": ,
                "policy_id": ,
                "effective_date": ,
                "expiration_date": ,
                "is_renewal": ,
                "term_credit_score": ,
                "term_length": ,
                "term_type": ,
                "renewal_type": ,
                "renewal_status": ,
                "renewal_status_reason_id": ,
                "renewal_status_description": ,
                "manual_reason": ,
                "bill_sched_id": ,
                "auto_payment_method_id": ,
                "auto_pay_days_before": ,
                "first_bill_whom_id": ,
                "bill_whom_id": ,
                "first_address_used_id": ,
                "first_email_used_id": ,
                "address_used_id": ,
                "email_used_id": ,
                "first_bill_checked": ,
                "first_payment_method_id": ,
                "has_write_off": ,
                "generate_pre_pay_schedule": ,
                "force_comm_recalc": ,
                "date_updated": ,
                "policy_term_number": ,
                "override_min_amount_due": ,
                "preferred_day_of_month_due": ,
                "earned_formula": ,
                "billing": {
                    "billing_schedule": {
                        "id": ,
                        "automatic_payment_reminder": ,
                        "bill_to_add_int": ,
                        "bill_to_agency": ,
                        "bill_to_insured": ,
                        "bill_to_mortgagee": ,
                        "custom_term": ,
                        "default_schedule": ,
                        "initial_invoice": ,
                        "initial_due": ,
                        "life_cycle_id": ,
                        "mid_term_due": ,
                        "mid_term_invoice": ,
                        "migrate_on_renewal": ,
                        "min_amount_due": ,
                        "name": ,
                        "nine_months_term": ,
                        "one_year_term": ,
                        "order": ,
                        "renewal_due": ,
                        "renewal_invoice": ,
                        "show_on_invoices": ,
                        "show_in_public_gateway": ,
                        "show_in_payment_sweep": ,
                        "six_months_term": ,
                        "three_months_term": ,
                        "three_years_term": ,
                        "eighteen_months_term": ,
                        "trans_cancellation": ,
                        "trans_mid_term_charges": ,
                        "trans_new_business": ,
                        "trans_reinstatement": ,
                        "trans_renewal": ,
                        "date_updated": ,
                        "use_recurring_ach_installment_fee": ,
                        "recurring_ach_installment_fee_amount": ,
                        "use_recurring_credit_card_installment_fee": ,
                        "recurring_credit_card_installment_fee_amount": ,
                        "use_initial_ach_installment_fee": ,
                        "initial_ach_installment_fee_amount": ,
                        "use_initial_credit_card_installment_fee": ,
                        "initial_credit_card_installment_fee_amount":
                    },
                    "return_premiums": [
                        {
                            "id": ,
                            "account_history_id": ,
                            "address_id": ,
                            "payment_id": ,
                            "policy_id": ,
                            "amount": ,
                            "date": ,
                            "reason": ,
                            "canceled": ,
                            "exported": ,
                            "transferred": ,
                            "check_number": ,
                            "product_description": ,
                            "check_divert": ,
                            "rejected": ,
                            "voided": ,
                            "account_history_transfer_id": ,
                            "date_updated": ,
                            "authorized": ,
                            "date_authorized": ,
                            "cleared_date": ,
                        },
                    ],  # sorted by date, newest first
                },
            },
            "contacts": {
                "agency": {
                    "id": ,
                    "accept_electronic_comm_statement": ,
                    "active": ,
                    "agency_inactive": ,
                    "agency_inactive_timestamp": ,
                    "agency_number": ,
                    "agency_group_number": ,
                    "background": ,
                    "date_added": ,
                    "commission_account_id": ,
                    "comm_statement_email_id": ,
                    "cc_email_notices": ,
                    "commission_structure": ,
                    "confirmation_email": ,
                    "default_state_id": ,
                    "direct_application_activity_to": ,
                    "display_agency_group_info_on_dec": ,
                    "dob": ,
                    "drivers_license": ,
                    "email_notices": ,
                    "email_print_list": ,
                    "fein_tax": ,
                    "legal_entity_type": ,
                    "date_business_started": ,
                    "risk_id_number": ,
                    "dba": ,
                    "flag": ,
                    "has_sweep_account": ,
                    "issue_commission_payments": ,
                    "issue_payments": ,
                    "issue_payments_account_id": ,
                    "mortgagee_statement": ,
                    "naic_number": ,
                    "vendor_number": ,
                    "name": ,
                    "notice_email_id": ,
                    "claim_activity_email_id": ,
                    "cc_claim_email_notices": ,
                    "notify_of_overdue_invoices": ,
                    "photo_id": ,
                    "permission_level_id": ,
                    "position": ,
                    "website": ,
                    "producer_number": ,
                    "same_as_ssn": ,
                    "ssn": ,
                    "ssn_group": ,
                    "sweep_account_id": ,
                    "system_tags": ,
                    "terminated": ,
                    "termination_reason": ,
                    "timezone": ,
                    "type": ,
                    "username": ,
                    "disallow_e2_val": ,
                    "is_god": ,
                    "oops_email": ,
                    "do_not_print_when_bill_whom": ,
                    "agency_billing_enabled": ,
                    "credit_score_account": ,
                    "date_updated": ,
                    "terms_conditions_accepted": ,
                    "follow_agency_quoting_restriction": ,
                    "purchase_date": ,
                    "cognito_username": ,
                    "default_agency_id": ,
                    "added_by": ,
                    "is_approved_vendor": ,
                    "gender": ,
                    "is_1099_reportable": ,
                    "agency_inception_date": ,
                    "agency_termination_date": ,
                    "previous_address_id": ,
                    "driver_license_date": ,
                    "license_state": ,
                    "phones": [
                        {
                            "id": ,
                            "date_updated": ,
                            "phone": ,
                            "type":
                        }
                    ],
                    "addresses": [
                        {
                            "id": ,
                            "address_city": ,
                            "address_county": ,
                            "address_country": ,
                            "address_line_1": ,
                            "address_line_2": ,
                            "address_state": ,
                            "address_zip": ,
                            "attention": ,
                            "type": ,
                            "type_label": ,
                            "latitude": ,
                            "longitude": ,
                            "date_updated": ,
                            "effective_start_date": ,
                            "effective_end_date":
                        }
                    ],
                    "emails": [
                        {
                            "id": ,
                            "email": ,
                            "type": ,
                            "date_updated":
                        }
                    ],
                }
                    "agent": {
                                    ...,
                    "phones": [
                        {
                                        ...
                        }
                    ],
                    "addresses": [
                        {
                                        ...
                        }
                    ],
                    "emails": [
                        {
                                        ...
                        }
                    ],
                },
                "named_insureds": [
                    {
                                        ...,
                        "phones": [
                            {
                                                ...
                            }
                        ],
                        "addresses": [
                            {
                                                ...
                            }
                        ],
                        "emails": [
                            {
                                            ...
                            }
                        ],
                    }
                ],
                "drivers": [
                    {
                                        ...,
                        "violations": [
                            {
                                "id": ,
                                "accident_violation_code": ,
                                "accident_violation_date": ,
                                "damage_total_amount": ,
                                "bodily_injury": ,
                                "is_fatality": ,
                                "violationtype": ,
                                "num_surcharge_points": ,
                                "accident_violation_description": ,
                                "accident_violation_location": ,
                                "conviction_date": ,
                                "property_damage": ,
                                "is_chargeable": ,
                                "excess_speed": ,
                                "speed_limit": ,
                                "actual_speed": ,
                                "responsible_percent": ,
                                "effective_date": ,
                                "expiration_date": ,
                                "is_manual": ,
                                "date_added": ,
                                "date_updated": ,
                                "created_by": ,
                                "updated_by": ,
                                "report_id": ,
                                "deleted":
                            }
                        ],
                        "phones": [
                            {
                                                ...
                            }
                        ],
                        "addresses": [
                            {
                                                ...
                            }
                        ],
                        "emails": [
                            {
                                            ...
                            }
                        ],
                        "driving_information": {
                            "married": ,
                            "marital_status": ,
                            "education_level": ,
                            "occupation": ,
                            "good_student": ,
                            "govt_employee": ,
                            "current_employer": ,
                            "years_with_current_employer": ,
                            "driver_training": ,
                            "driver_training_date": ,
                            "driver_license_status": ,
                            "years_at_current_address": ,
                            "years_at_previous_address": ,
                            "address_owned": ,
                            "relation_to_applicant": ,
                            "distant_student": ,
                        }
                    }
                ],
                "non_drivers": [
                    {
                                        ...,
                        "phones": [
                            {
                                                ...
                            }
                        ],
                        "addresses": [
                            {
                                                ...
                            }
                        ],
                        "emails": [
                            {
                                            ...
                            }
                        ],
                        "driving_information": {...}
                    }
                ],
                "others": [  // other risk additional interests that are not categorized above
                    {
                        ...
                    }
                ]
            },
            "policy": {
                "id": ,
                "policy_number": ,
                "policy_number_origin": ,
                "sequence_id": ,
                "policy_number_normalized": ,
                "active": ,
                "rewritten": ,
                "show_app": ,
                "date_added": ,
                "policy_group_id": ,
                "copied_from_rev_id": ,
                "copied_to_rev_id": ,
                "flag": ,
                "inception_date": ,
                "system_tags": ,
                "submit_bound": ,
                "unbound_option_id": ,
                "submit_receipt_email": ,
                "submit_receipt_name": ,
                "submit_confirm_email": ,
                "submit_confirm_name": ,
                "date_updated": ,
                "do_not_automatically_rewrite": ,
                "account_number": ,
                "in_progress_oos_transaction_id": ,
                "cancel_delay_date":
            },
        },
    },
]

Code
Retrieve all data points specific to policies for the given revision ids.

Parameters
----------
revision_ids : list of str, required
    List of revision ids to generate data points for policies
property_ids : list of str, optional
    List of property ids to filter results

Notes
-----
Every return premium of the policy is listed under
``revision.policy_term.billing.return_premiums``, sorted from newest to
oldest, so ``return_premiums[0]`` is always the most recent return premium.
Return premium dates carry no time of day, so same-day return premiums are
ordered by when the underlying account history entry was raised.

Returns
-------
success : bool
    True if successful, false if not
message : list of str
    Human-readable messages.
data :
    Contains the data points of the policy in the following format:
[
    {
        "revision": {
            "id": ,
            "policy_id": ,
            "policy_term_id": ,
            "cancel_date": ,
            "commission_rate": ,
            "commission_rate_adjustment": ,
            "commit_date": ,
            "commit_date_time": ,
            "create_date": ,
            "date_archived": ,
            "dec_description": ,
            "description": ,
            "written_fee": ,
            "grant_mortgagee_extension": ,
            "override_commission": ,
            "policy_status": ,
            "policy_status_reason_id": ,
            "policy_type_id": ,
            "written_premium": ,
            "print_dec": ,
            "reinstate_at_commit": ,
            "revision_date": ,
            "revision_state": ,
            "annual_fee": ,
            "annual_premium": ,
            "underwriting_questions": ,
            "underwriting_contacted": ,
            "underwriting_contact_date": ,
            "builder_pending": ,
            "deleted": ,
            "credit_report_permissions": ,
            "date_updated": ,
            "last_visited": ,
            "builder_ready_to_rate": ,
            "review_workflow_state": ,
            "signature_type": ,
            "review_workflow_request_reason": ,
            "underwriting_options": ,
            "primary_property_id": ,
            "written_premium_delta": ,
            "cancellation_revision_id": ,
            "previous_revision_state": ,
            "overpayment": ,
            "coverages": [
                {
                    "revision_item_id": ,
                    "revision_id": ,
                    "sub_line_instance_id": ,
                    "item_id": ,
                    "apply_date": ,
                    "limit": ,
                    "limit_type": ,
                    "limit2_type": ,
                    "limit3_type": ,
                    "limit2": ,
                    "limit3": ,
                    "deductible": ,
                    "written_premium": ,
                    "annual_premium": ,
                    "written_fee": ,
                    "annual_fee": ,
                    "manual": ,
                    "loss_exposure_group": ,
                    "builder_obj": ,
                    "link_obj": ,
                    "rating_details": ,
                    "date_added": ,
                    "date_added_micro": ,
                    "deleted": ,
                    "date_deleted": ,
                    "deleted_by": ,
                    "prev_adj_amt": ,
                    "persist_status": ,
                    "resolved": ,
                    "status_reason": ,
                    "date_updated": ,
                    "limit_updated": ,
                    "previous_id": ,
                }
            ],
            "risks": {
                "vehicles": [
                    {
                        "id",
                        "revision_id": ,
                        "address_accuracy": ,
                        "address_city": ,
                        "address_county": ,
                        "address_line_1": ,
                        "address_line_2": ,
                        "address_state": ,
                        "address_country": ,
                        "address_zip": ,
                        "copy_address": ,
                        "county_specify": ,
                        "date_added": ,
                        "date_added_micro": ,
                        "deleted": ,
                        "fire_district_distance": ,
                        "flag": ,
                        "gross_area": ,
                        "hydrant_distance": ,
                        "inspection_requested_date": ,
                        "inspection_vendor": ,
                        "latitude": ,
                        "longitude": ,
                        "loss_history_report_content": ,
                        "loss_history_report_number": ,
                        "name": ,
                        "next_inspection_date": ,
                        "property_val": ,
                        "protection_class_id": ,
                        "iso_pc_data": ,
                        "verisk_passport_data": ,
                        "prefill_services_data": ,
                        "replace_contents": ,
                        "replace_loss": ,
                        "replace_other": ,
                        "replacement_cost_value": ,
                        "approved_limits": ,
                        "stories": ,
                        "type": ,
                        "year_built": ,
                        "annual_fee": ,
                        "annual_premium": ,
                        "written_fee": ,
                        "written_premium": ,
                        "date_updated": ,
                        "risk_data": ,
                        "builder_ready_to_rate": ,
                        "property_group_id": ,
                        "previous_id": ,
                        "location_number": ,
                        "vehicle_year": ,
                        "vehicle_make": ,
                        "vehicle_model": ,
                        "vehicle_vin": ,
                        "vehicle_body_type": ,
                        "new_vehicle": ,
                        "cost_new_vehicle": ,
                        "performance": ,
                        "date_vehicle_leased": ,
                        "date_vehicle_purchased": ,
                        "miles_to_work": ,
                        "per_week_days_driven": ,
                        "per_month_weeks_driven": ,
                        "usage": ,
                        "multi_car": ,
                        "car_pool": ,
                        "air_bags": ,
                        "anti_lock_brakes": ,
                        "anti_theft_device": ,
                        "symbol_age_group": ,
                        "symbol_collision": ,
                        "symbol_comprehensive": ,
                        "symbol_liability": ,
                        "symbol_medical_payments": ,
                        "territory": ,
                        "horse_power": ,
                        "vehicle_class": ,
                        "vehicle_type": ,
                        "owned_or_leased": ,
                        "annual_mileage": ,
                        "odometer_reading": ,
                        "seat_belts": ,
                        "seat_belt_type": ,
                        "air_bag_type": ,
                        "anti_theft_code": ,
                        "anti_theft_device_type": ,
                        "registered_state": ,
                        "garage_code": ,
                        "customized_equipment": ,
                        "used_for_ride_share": ,
                        "daytime_running_lights": ,
                        "gross_vehicle_weight": ,
                        "purchased_new": ,
                        "acres": ,
                        "legal_description": ,
                        "plate_number": ,
                        "coverages": [
                            {
                                "id": ,
                                "property_id": ,
                                "sub_line_instance_id": ,
                                "item_id": ,
                                "apply_date": ,
                                "limit": ,
                                "limit_type": ,
                                "limit_3_type": ,
                                "limit_2_type": ,
                                "limit_2": ,
                                "limit_3": ,
                                "deductible": ,
                                "written_premium": ,
                                "annual_premium": ,
                                "written_fee": ,
                                "annual_fee": ,
                                "manual": ,
                                "loss_exposure_group": ,
                                "builder_obj": ,
                                "link_obj": ,
                                "rating_details": ,
                                "date_added": ,
                                "date_added_micro": ,
                                "deleted": ,
                                "date_deleted": ,
                                "deleted_by": ,
                                "prev_adj_amt": ,
                                "persist_status": ,
                                "resolved": ,
                                "status_reason": ,
                                "date_updated": ,
                                "limit_updated": ,
                                "previous_id": ,
                            }
                        ],
                        "additional_interests": [
                            {
                                "id": ,
                                "property_id": ,
                                "contact_id": ,
                                "mortgagee": ,
                                "inspector": ,
                                "description": ,
                                "loan_num": ,
                                "type": ,
                                "date_added": ,
                                "dec_mort_statement": ,
                                "date_updated": ,
                                "driver": ,
                                "tenant": ,
                            }
                        ],
                    }
                ],
                "properties": [
                    ...
                ],
            },
            "policy_term": {
                "id": ,
                "policy_id": ,
                "effective_date": ,
                "expiration_date": ,
                "is_renewal": ,
                "term_credit_score": ,
                "term_length": ,
                "term_type": ,
                "renewal_type": ,
                "renewal_status": ,
                "renewal_status_reason_id": ,
                "renewal_status_description": ,
                "manual_reason": ,
                "bill_sched_id": ,
                "auto_payment_method_id": ,
                "auto_pay_days_before": ,
                "first_bill_whom_id": ,
                "bill_whom_id": ,
                "first_address_used_id": ,
                "first_email_used_id": ,
                "address_used_id": ,
                "email_used_id": ,
                "first_bill_checked": ,
                "first_payment_method_id": ,
                "has_write_off": ,
                "generate_pre_pay_schedule": ,
                "force_comm_recalc": ,
                "date_updated": ,
                "policy_term_number": ,
                "override_min_amount_due": ,
                "preferred_day_of_month_due": ,
                "earned_formula": ,
                "billing": {
                    "billing_schedule": {
                        "id": ,
                        "automatic_payment_reminder": ,
                        "bill_to_add_int": ,
                        "bill_to_agency": ,
                        "bill_to_insured": ,
                        "bill_to_mortgagee": ,
                        "custom_term": ,
                        "default_schedule": ,
                        "initial_invoice": ,
                        "initial_due": ,
                        "life_cycle_id": ,
                        "mid_term_due": ,
                        "mid_term_invoice": ,
                        "migrate_on_renewal": ,
                        "min_amount_due": ,
                        "name": ,
                        "nine_months_term": ,
                        "one_year_term": ,
                        "order": ,
                        "renewal_due": ,
                        "renewal_invoice": ,
                        "show_on_invoices": ,
                        "show_in_public_gateway": ,
                        "show_in_payment_sweep": ,
                        "six_months_term": ,
                        "three_months_term": ,
                        "three_years_term": ,
                        "eighteen_months_term": ,
                        "trans_cancellation": ,
                        "trans_mid_term_charges": ,
                        "trans_new_business": ,
                        "trans_reinstatement": ,
                        "trans_renewal": ,
                        "date_updated": ,
                        "use_recurring_ach_installment_fee": ,
                        "recurring_ach_installment_fee_amount": ,
                        "use_recurring_credit_card_installment_fee": ,
                        "recurring_credit_card_installment_fee_amount": ,
                        "use_initial_ach_installment_fee": ,
                        "initial_ach_installment_fee_amount": ,
                        "use_initial_credit_card_installment_fee": ,
                        "initial_credit_card_installment_fee_amount":
                    },
                    "return_premiums": [
                        {
                            "id": ,
                            "account_history_id": ,
                            "address_id": ,
                            "payment_id": ,
                            "policy_id": ,
                            "amount": ,
                            "date": ,
                            "reason": ,
                            "canceled": ,
                            "exported": ,
                            "transferred": ,
                            "check_number": ,
                            "product_description": ,
                            "check_divert": ,
                            "rejected": ,
                            "voided": ,
                            "account_history_transfer_id": ,
                            "date_updated": ,
                            "authorized": ,
                            "date_authorized": ,
                            "cleared_date": ,
                        },
                    ],  # sorted by date, newest first
                },
            },
            "contacts": {
                "agency": {
                    "id": ,
                    "accept_electronic_comm_statement": ,
                    "active": ,
                    "agency_inactive": ,
                    "agency_inactive_timestamp": ,
                    "agency_number": ,
                    "agency_group_number": ,
                    "background": ,
                    "date_added": ,
                    "commission_account_id": ,
                    "comm_statement_email_id": ,
                    "cc_email_notices": ,
                    "commission_structure": ,
                    "confirmation_email": ,
                    "default_state_id": ,
                    "direct_application_activity_to": ,
                    "display_agency_group_info_on_dec": ,
                    "dob": ,
                    "drivers_license": ,
                    "email_notices": ,
                    "email_print_list": ,
                    "fein_tax": ,
                    "legal_entity_type": ,
                    "date_business_started": ,
                    "risk_id_number": ,
                    "dba": ,
                    "flag": ,
                    "has_sweep_account": ,
                    "issue_commission_payments": ,
                    "issue_payments": ,
                    "issue_payments_account_id": ,
                    "mortgagee_statement": ,
                    "naic_number": ,
                    "vendor_number": ,
                    "name": ,
                    "notice_email_id": ,
                    "claim_activity_email_id": ,
                    "cc_claim_email_notices": ,
                    "notify_of_overdue_invoices": ,
                    "photo_id": ,
                    "permission_level_id": ,
                    "position": ,
                    "website": ,
                    "producer_number": ,
                    "same_as_ssn": ,
                    "ssn": ,
                    "ssn_group": ,
                    "sweep_account_id": ,
                    "system_tags": ,
                    "terminated": ,
                    "termination_reason": ,
                    "timezone": ,
                    "type": ,
                    "username": ,
                    "disallow_e2_val": ,
                    "is_god": ,
                    "oops_email": ,
                    "do_not_print_when_bill_whom": ,
                    "agency_billing_enabled": ,
                    "credit_score_account": ,
                    "date_updated": ,
                    "terms_conditions_accepted": ,
                    "follow_agency_quoting_restriction": ,
                    "purchase_date": ,
                    "cognito_username": ,
                    "default_agency_id": ,
                    "added_by": ,
                    "is_approved_vendor": ,
                    "gender": ,
                    "is_1099_reportable": ,
                    "agency_inception_date": ,
                    "agency_termination_date": ,
                    "previous_address_id": ,
                    "driver_license_date": ,
                    "license_state": ,
                    "phones": [
                        {
                            "id": ,
                            "date_updated": ,
                            "phone": ,
                            "type":
                        }
                    ],
                    "addresses": [
                        {
                            "id": ,
                            "address_city": ,
                            "address_county": ,
                            "address_country": ,
                            "address_line_1": ,
                            "address_line_2": ,
                            "address_state": ,
                            "address_zip": ,
                            "attention": ,
                            "type": ,
                            "type_label": ,
                            "latitude": ,
                            "longitude": ,
                            "date_updated": ,
                            "effective_start_date": ,
                            "effective_end_date":
                        }
                    ],
                    "emails": [
                        {
                            "id": ,
                            "email": ,
                            "type": ,
                            "date_updated":
                        }
                    ],
                }
                    "agent": {
                                    ...,
                    "phones": [
                        {
                                        ...
                        }
                    ],
                    "addresses": [
                        {
                                        ...
                        }
                    ],
                    "emails": [
                        {
                                        ...
                        }
                    ],
                },
                "named_insureds": [
                    {
                                        ...,
                        "phones": [
                            {
                                                ...
                            }
                        ],
                        "addresses": [
                            {
                                                ...
                            }
                        ],
                        "emails": [
                            {
                                            ...
                            }
                        ],
                    }
                ],
                "drivers": [
                    {
                                        ...,
                        "violations": [
                            {
                                "id": ,
                                "accident_violation_code": ,
                                "accident_violation_date": ,
                                "damage_total_amount": ,
                                "bodily_injury": ,
                                "is_fatality": ,
                                "violationtype": ,
                                "num_surcharge_points": ,
                                "accident_violation_description": ,
                                "accident_violation_location": ,
                                "conviction_date": ,
                                "property_damage": ,
                                "is_chargeable": ,
                                "excess_speed": ,
                                "speed_limit": ,
                                "actual_speed": ,
                                "responsible_percent": ,
                                "effective_date": ,
                                "expiration_date": ,
                                "is_manual": ,
                                "date_added": ,
                                "date_updated": ,
                                "created_by": ,
                                "updated_by": ,
                                "report_id": ,
                                "deleted":
                            }
                        ],
                        "phones": [
                            {
                                                ...
                            }
                        ],
                        "addresses": [
                            {
                                                ...
                            }
                        ],
                        "emails": [
                            {
                                            ...
                            }
                        ],
                        "driving_information": {
                            "married": ,
                            "marital_status": ,
                            "education_level": ,
                            "occupation": ,
                            "good_student": ,
                            "govt_employee": ,
                            "current_employer": ,
                            "years_with_current_employer": ,
                            "driver_training": ,
                            "driver_training_date": ,
                            "driver_license_status": ,
                            "years_at_current_address": ,
                            "years_at_previous_address": ,
                            "address_owned": ,
                            "relation_to_applicant": ,
                            "distant_student": ,
                        }
                    }
                ],
                "non_drivers": [
                    {
                                        ...,
                        "phones": [
                            {
                                                ...
                            }
                        ],
                        "addresses": [
                            {
                                                ...
                            }
                        ],
                        "emails": [
                            {
                                            ...
                            }
                        ],
                        "driving_information": {...}
                    }
                ],
                "others": [  // other risk additional interests that are not categorized above
                    {
                        ...
                    }
                ]
            },
            "policy": {
                "id": ,
                "policy_number": ,
                "policy_number_origin": ,
                "sequence_id": ,
                "policy_number_normalized": ,
                "active": ,
                "rewritten": ,
                "show_app": ,
                "date_added": ,
                "policy_group_id": ,
                "copied_from_rev_id": ,
                "copied_to_rev_id": ,
                "flag": ,
                "inception_date": ,
                "system_tags": ,
                "submit_bound": ,
                "unbound_option_id": ,
                "submit_receipt_email": ,
                "submit_receipt_name": ,
                "submit_confirm_email": ,
                "submit_confirm_name": ,
                "date_updated": ,
                "do_not_automatically_rewrite": ,
                "account_number": ,
                "in_progress_oos_transaction_id": ,
                "cancel_delay_date":
            },
        },
    },
]