claims

Auto-Assign an adjuster to a Claim

Bifurcates a Claim

Bulk assign claim parties to claims.

Code
Parameters
----------
params : list[dict], required
    Payload matching ``ClaimBulkReassignmentRequestSchema`` with one or
    more claim/contact assignments to create.

Returns
-------
success : bool
    True if successful, false if not.
messages : list[str]
    List of human-readable messages.
data : str
    Human-readable status string returned by
    ``ClaimContactService.bulk_assign``.

Bulk reassign claim parties on claims.

Code
Parameters
----------
params : list[dict], required
    Payload matching ``ClaimBulkReassignmentRequestSchema`` with one or
    more claim/contact assignment updates.

Returns
-------
success : bool
    True if successful, false if not.
messages : list[str]
    List of human-readable messages.
data : str
    Human-readable status string returned by
    ``ClaimContactService.bulk_reassign``.

Bulk unassign claim parties from claims.

Code
Parameters
----------
params : dict, required
    Payload matching ``ClaimBulkUnassignmentRequestSchema``.
    Includes one or more claim/contact assignments to remove.

Returns
-------
success : bool
    True if successful, false if not.
messages : list[str]
    List of human-readable messages.
data : str
    Human-readable status string returned by
    ``ClaimContactService.bulk_unassign``.

Code
Generate ClaimSearch SSO data via Tray.io.

Collects the authenticated user's contact attributes, calls Tray.io
to produce SSO payload data, and returns it for the frontend to
open ClaimSearch's ACS endpoint.

Parameters
----------
claim_id : str, required
    UUID of the claim
vendor_reference_id : str, optional
    ISO file number for deep-linking to a specific match report.
    If provided, Tray builds a RelayState for the report page.
    If omitted, lands on ClaimSearch home page.

Returns
-------
success : bool
    False with "ClaimSearch SSO is not configured" when the installation
    has no portal SSO set up
data : dict
    - acs_url: ClaimSearch ACS endpoint URL
    - saml_response: base64-encoded signed SAML Response, if provided
    - relay_state: RelayState for deep-linking (empty for home page)

Code
Report whether the ClaimSearch portal can be opened for a claim.

The claims history panel shows the "ClaimSearch Portal" and
"View in Portal" buttons only when this returns true. It is false only
when Tray.io answers that portal SSO is not configured for the
installation.

Parameters
----------
claim_id : str, required
    UUID of the claim

Returns
-------
success : bool
data : dict
    - sso_enabled: bool - True when the portal buttons should be shown

Create a claim date

Code
Parameters
----------
claim_id : str, required
    the claim id
claim_date_type : str, required
    the claim date type
claim_date : str, required
    the claim date (format: YYYY-mm-dd)

Returns
-------
success : bool
    True if successful, false if not
messages : list[str]
    List of human-readable error messages
data: dict
    The claim date.
    ::
    {
        "dateId": "<uuid>",
        "type": "<claim-date-type>",
        "dateString": "<mm/dd/YYYY>",
    }

Code
Batch retrieve all data points specific to claims given claim ids

Parameters
----------
claim_ids : list of str, required
    List of claims ids

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    Human-readable messages.
data :
    Contains the data points for claims in the following format:
    [
        {
            "claim": {
                "id": str,
                "active": boolean,
                "additional_information": {
                    "Best Contact Phone": str,
                    "Reported To": str,
                    "Police/Fire Dept to Which Reported": str,
                    "Best Contact Email": str,
                    "Reported By": str,
                    "Additional Information": str
                },
                "cat_id": str,
                "claim_number": str,
                "claim_number_origin": str,
                "county": str,
                "county_specify": str,
                "date_added": str,
                "description": str,
                "flag": str,
                "iso_transaction_type": str,
                "last_modified": str,
                "last_rein_report_date": str,
                "loss_address_city": str,
                "loss_address_id": str,
                "loss_address_line1": str,
                "loss_address_line2": str,
                "loss_address_listed": boolean,
                "loss_address_state": str,
                "loss_address_zip": str,
                "loss_date": str,
                "policy_id": str,
                "reinsurance_reserve": float,
                "reinsurancelae_reserve": float,
                "reinsurance_monitor_status": str,
                "salvage_reserve": float,
                "status": str,
                "subrogation_reserve": float,
                "dual_masthead": boolean,
                "system_tags": str,
                "type": str,
                "type_manual": boolean,
                "loss_address_latitude": float,
                "loss_address_longitude": float,
                "reported_method": str,
                "fnol_number": str,
                "no_vehicles": int,
                "hit_and_run": boolean,
                "revision_id": str,
                "date_updated": str
            },
            "revision_id": str,
            "claim_items": [
                {
                    "id": str,
                    "description": str,
                    "item_id": str,
                    "adjusting_reserve": float,
                    "claim_id": str,
                    "loss_id": str,
                    "loss_type": str,
                    "coverage_deductible": float,
                    "legal_reserve": float,
                    "loss_reserve": float,
                    "override": boolean,
                    "deleted": boolean,
                    "date_updated": str
                }
            ],
            "claim_change_logs": [
                {
                    "id": str,
                    "claim_id": str,
                    "claim_number": str,
                    "claim_status": str,
                    "claim_item_id": str,
                    "date_cursor": str,
                    "date_stamp": str,
                    "transaction": str,
                    "changed_from": str,
                    "changed_to": str,
                    "deleted": boolean,
                    "date_updated": str
                }
            ],
            "claim_properties": [],
            "claim_dates": [
                {
                    "id": str,
                    "claim_id": str,
                    "date": str,
                    "type": str,
                    "date_updated": str
                }
            ],
            "claim_contacts": [
                {
                    "id": str,
                    "claim_id": str,
                    "contact_id": str,
                    "adjuster": boolean,
                    "public_adjuster": boolean,
                    "claimant": boolean,
                    "contractor": boolean,
                    "contractor_description": str,
                    "date_added": str,
                    "defendant_attorney": boolean,
                    "plaintiff_attorney": boolean,
                    "named_insured": boolean,
                    "producer": boolean,
                    "supervisor": boolean,
                    "police_department": boolean,
                    "public_claims_adjuster": boolean,
                    "fire_department": boolean,
                    "medical_provider": boolean,
                    "driver": boolean,
                    "passenger": boolean,
                    "pedestrian": boolean,
                    "witness": boolean,
                    "owner": boolean,
                    "other": boolean,
                    "date_updated": str,
                    "contact": {
                        "id": str,
                        "accept_electronic_comm_statement": boolean,
                        "active": boolean,
                        "agency_inactive": boolean,
                        "agency_inactive_timestamp": str,
                        "agency_group_number": str,
                        "agency_number": str,
                        "background": str,
                        "date_added": str,
                        "added_by": str,
                        "commission_account_id": str,
                        "comm_statement_email_id": str,
                        "cc_email_notices": str,
                        "commission_structure": str,
                        "confirmation_email": str,
                        "default_state_id": str,
                        "direct_application_activity_to": str,
                        "display_agency_group_info_on_dec": boolean,
                        "dob": str,
                        "drivers_license": str,
                        "email_notices": boolean,
                        "email_print_list": boolean,
                        "fein_tax": str,
                        "legal_entity_type": str,
                        "date_business_started": str,
                        "risk_id_number": str,
                        "dba": str,
                        "flag": str,
                        "has_sweep_account": boolean,
                        "issue_commission_payments": boolean,
                        "issue_payments": boolean,
                        "issue_payments_account_id": str,
                        "last_login": str,
                        "mortgagee_statement": str,
                        "naic_number": str,
                        "vendor_number": str,
                        "name": "Test Agency",
                        "notice_email_id": str,
                        "claim_activity_email_id": str,
                        "cc_claim_email_notices": str,
                        "notify_of_overdue_invoices": boolean,
                        "photo_id": str,
                        "permission_level_id": str,
                        "position": str,
                        "website": str,
                        "producer_number": str,
                        "same_as_ssn": boolean,
                        "ssn": str,
                        "ssn_group": str,
                        "sweep_account_id": str,
                        "system_tags": {
                            <id>: str
                        },
                        "terminated": boolean,
                        "termination_reason": str,
                        "timezone": str,
                        "type": str,
                        "username": str,
                        "disallow_e2_val": boolean,
                        "is_approved_vendor": boolean,
                        "is1099_reportable": boolean,
                        "oops_email": str,
                        "do_not_print_when_bill_whom": boolean,
                        "agency_billing_enabled": boolean,
                        "credit_score_account": str,
                        "date_updated": str,
                        "terms_conditions_accepted": boolean,
                        "follow_agency_quoting_restriction": boolean,
                        "purchase_date": str,
                        "cognito_username": str,
                        "default_agency_id": str,
                        "gender": str,
                        "agency_inception_date": str,
                        "agency_termination_date": str,
                        "driver_license_date": str,
                        "license_state": str,
                        "previous_address_id": str
                    }
                }
            ],
            "recovery_history": [
                {
                    "id": str,
                    "change_in_reserve": float,
                    "claim_id": str,
                    "claim_item_id": str,
                    "claim_transaction_id": str,
                    "date_created": str,
                    "modified_by": str,
                    "received": float,
                    "snapshot": str,
                    "total_received": float,
                    "total_reserves": float,
                    "historical": boolean,
                    "change_reason": str,
                    "date_updated": str
                }
            ],
            "losses_incurred": [
                {
                    "id": str,
                    "change_in_reserve": float,
                    "claim_id": str,
                    "date_created": str,
                    "date_created_micro": int,
                    "losses_incurred": float,
                    "losses_paid": float,
                    "modified_by": str,
                    "snapshot": str,
                    "historical": boolean,
                    "claim_transaction_id": str,
                    "date_updated": str,
                    "loss_items": [
                        {
                            "id": str,
                            "losses_incurred_id": str,
                            "claim_item_id": str,
                            "claim_item_name": str,
                            "loss_reserve": float,
                            "adjusting_reserve": float,
                            "legal_reserve": float,
                            "change_in_loss_reserve": float,
                            "change_in_adjusting_reserve": float,
                            "change_in_legal_reserve": float,
                            "loss_paid": float,
                            "adjusting_paid": float,
                            "legal_paid": float,
                            "total_loss_paid": float,
                            "total_adjusting_paid": float,
                            "total_legal_paid": float,
                            "date_updated": str
                        }
                    ]
                }
            ],
            "perils": [
                {
                    "id": str,
                    "aplus_code": str,
                    "lexis_nexis_code": str,
                    "code": str,
                    "date_updated": str,
                    "name": str
                }
            ],
            "claim_transactions": [
                {
                    "id": str,
                    "address_id": str,
                    "amount": float,
                    "check_display": str,
                    "check_number": str,
                    "claim_id": str,
                    "claim_item_id": str,
                    "cleared_date": str,
                    "contact_id": str,
                    "description": str,
                    "deductible": float,
                    "exported": boolean,
                    "item_amounts": str,
                    "memo": str,
                    "payment_method_id": str,
                    "recovery_category": str,
                    "reinsurance_contract_contact_id": str,
                    "selected_payees": str,
                    "transaction_date": str,
                    "type": str,
                    "voided": boolean,
                    "voided_date": str,
                    "historical": boolean,
                    "check_date": str,
                    "date_updated": str,
                    "contact": {
                        "id": str,
                        "accept_electronic_comm_statement": boolean,
                        "active": boolean,
                        "agency_inactive": boolean,
                        "agency_inactive_timestamp": str,
                        "agency_group_number": str,
                        "agency_number": str,
                        "background": str,
                        "date_added": str,
                        "added_by": str,
                        "commission_account_id": str,
                        "comm_statement_email_id": str,
                        "cc_email_notices": str,
                        "commission_structure": str,
                        "confirmation_email": str,
                        "default_state_id": str,
                        "direct_application_activity_to": str,
                        "display_agency_group_info_on_dec": boolean,
                        "dob": str,
                        "drivers_license": str,
                        "email_notices": boolean,
                        "email_print_list": boolean,
                        "fein_tax": str,
                        "legal_entity_type": str,
                        "date_business_started": str,
                        "risk_id_number": str,
                        "dba": str,
                        "flag": str,
                        "has_sweep_account": boolean,
                        "issue_commission_payments": boolean,
                        "issue_payments": boolean,
                        "issue_payments_account_id": str,
                        "last_login": str,
                        "mortgagee_statement": str,
                        "naic_number": str,
                        "vendor_number": str,
                        "name": "Test Agency",
                        "notice_email_id": str,
                        "claim_activity_email_id": str,
                        "cc_claim_email_notices": str,
                        "notify_of_overdue_invoices": boolean,
                        "photo_id": str,
                        "permission_level_id": str,
                        "position": str,
                        "website": str,
                        "producer_number": str,
                        "same_as_ssn": boolean,
                        "ssn": str,
                        "ssn_group": str,
                        "sweep_account_id": str,
                        "system_tags": {
                            <id>: str
                        },
                        "terminated": boolean,
                        "termination_reason": str,
                        "timezone": str,
                        "type": str,
                        "username": str,
                        "disallow_e2_val": boolean,
                        "is_approved_vendor": boolean,
                        "is1099_reportable": boolean,
                        "oops_email": str,
                        "do_not_print_when_bill_whom": boolean,
                        "agency_billing_enabled": boolean,
                        "credit_score_account": str,
                        "date_updated": str,
                        "terms_conditions_accepted": boolean,
                        "follow_agency_quoting_restriction": boolean,
                        "purchase_date": str,
                        "cognito_username": str,
                        "default_agency_id": str,
                        "gender": str,
                        "agency_inception_date": str,
                        "agency_termination_date": str,
                        "driver_license_date": str,
                        "license_state": str,
                        "previous_address_id": str
                    }
                }
            ],
            "injuries": [
                {
                    "id": str,
                    "claim_id": str,
                    "contact_id": str,
                    "description": str,
                    "fatality": boolean,
                    "transferred_to_hospital": boolean,
                    "head_injury": boolean,
                    "loss_of_consciousness": boolean,
                    "loss_of_limb": boolean,
                    "prior_injuries": boolean,
                    "prior_medical_conditions": str,
                    "current_medical_conditions": str,
                    "hicn": str,
                    "date_added": str,
                    "date_updated": str,
                    "contact": {
                        {
                            "id": str,
                            "accept_electronic_comm_statement": boolean,
                            "active": boolean,
                            "agency_inactive": boolean,
                            "agency_inactive_timestamp": str,
                            "agency_group_number": str,
                            "agency_number": str,
                            "background": str,
                            "date_added": str,
                            "added_by": str,
                            "commission_account_id": str,
                            "comm_statement_email_id": str,
                            "cc_email_notices": str,
                            "commission_structure": str,
                            "confirmation_email": str,
                            "default_state_id": str,
                            "direct_application_activity_to": str,
                            "display_agency_group_info_on_dec": boolean,
                            "dob": str,
                            "drivers_license": str,
                            "email_notices": boolean,
                            "email_print_list": boolean,
                            "fein_tax": str,
                            "legal_entity_type": str,
                            "date_business_started": str,
                            "risk_id_number": str,
                            "dba": str,
                            "flag": str,
                            "has_sweep_account": boolean,
                            "issue_commission_payments": boolean,
                            "issue_payments": boolean,
                            "issue_payments_account_id": str,
                            "last_login": str,
                            "mortgagee_statement": str,
                            "naic_number": str,
                            "vendor_number": str,
                            "name": "Test Agency",
                            "notice_email_id": str,
                            "claim_activity_email_id": str,
                            "cc_claim_email_notices": str,
                            "notify_of_overdue_invoices": boolean,
                            "photo_id": str,
                            "permission_level_id": str,
                            "position": str,
                            "website": str,
                            "producer_number": str,
                            "same_as_ssn": boolean,
                            "ssn": str,
                            "ssn_group": str,
                            "sweep_account_id": str,
                            "system_tags": {
                                <id>: str
                            },
                            "terminated": boolean,
                            "termination_reason": str,
                            "timezone": str,
                            "type": str,
                            "username": str,
                            "disallow_e2_val": boolean,
                            "is_approved_vendor": boolean,
                            "is1099_reportable": boolean,
                            "oops_email": str,
                            "do_not_print_when_bill_whom": boolean,
                            "agency_billing_enabled": boolean,
                            "credit_score_account": str,
                            "date_updated": str,
                            "terms_conditions_accepted": boolean,
                            "follow_agency_quoting_restriction": boolean,
                            "purchase_date": str,
                            "cognito_username": str,
                            "default_agency_id": str,
                            "gender": str,
                            "agency_inception_date": str,
                            "agency_termination_date": str,
                            "driver_license_date": str,
                            "license_state": str,
                            "previous_address_id": str
                        }
                    }
                }
            ]
        }
    ]

Exports claim payments and optionally assigns a check number to them. The optional check number can be manually or automatically assigned.

Code
In case any payment in the request is not exported there are two possible individual payment
response detail messages:
#. payment not found
#. payment already exported

Parameters
----------
payments : list, required
    List of dictionaries containing the following data representation. ::
        [
            {
                'id': string (uuid), ClaimTransaction.id
                'check_number': int/string, check number (int), 'auto_assign', or None
            },
            ...
        ]
assign_check_date : bool
    If true, assign today's date to all payments.

Returns
-------
success : bool
    True if all exports were successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    List of dictionaries containing the following data representation. ::
        [
            {
                'id': string (uuid), ClaimTransaction.id,
                'check_date': date string, i.e. 2017-01-31,
                'check_number': int, The number if one was assigned, or None if not,
                'status': string, 'success' if succesfully exported, or 'error' if not,
                'detail': string, error message or None
            },
            ...
        ]

Retrieve all parties associated with a claim.

Code
Parameters
----------
claim_id : str, required
    UUID of the claim.

Returns
-------
success : bool
    True if successful, false if not.
messages : list[str]
    List of human-readable messages.
data : list[dict]
    Serialized claim parties. Most rows are persisted claim-contact
    associations; when ``claims.pull-current-mortgagees`` is enabled,
    current policy mortgagees and named insureds missing from the claim
    appear as virtual parties (``id`` is null), and mortgagee and
    named-insured rows carry an optional ``mortgagee_status`` or
    ``named_insured_status`` tag (``no_change``, ``removed``, ``current``,
    ``not_on_policy``). Mortgagee rows also carry ``mortgagee_order``, their
    position in policy order: loss-date revision first, then mortgagees only
    on the current revision (when the setting is enabled). It is null for a
    mortgagee on neither revision and when the claim has no policy, loss date
    or loss-date revision. Every row carries ``is_internal``: whether its
    contact carries the Internal System Tag (false on a virtual party).

Request and response schemas are located at
``lib/api/api_specs/request-get_all_associated_claims_parties.json`` and
``lib/api/api_specs/response-get_all_associated_claims_parties.json``,
respectively.

Retrieve all storms/catastrophes.

Code
Parameters
----------

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : list
    A list of catastrophe dicts having the form:
    ::
        [
            {
                "date_time": "2020-01-15 15:53:42",
                "date_updated": "2020-01-15 15:53:42",
                "end_date_time": "2020-01-15 15:53:42",
                "id": str,
                "location": str,
                "pcs": int,
                "title": str,
            }
        ]

Code
This endpoint returns a comprehensive list of all accounting transactions associated with a specific claim.
The transactions include:

- **Payments**: Loss, adjusting, and legal payments made against the claim
- **Reserves**: Loss, adjusting, and legal reserves established for the claim
- **Recoveries**: Reinsurance, subrogation, salvage, and reinsurance LAE recoveries
- **Recovery Reserves**: Reserves established for potential recoveries

Transactions are sorted by date in descending order (most recent first) and include detailed
information about exposures, payees, and payment methods.
This endpoint supports filtering and pagination.

Permissions
-----------
Requires read access to at least one of:
    - 'britecore/claims/accounting'
    - 'agent/claims'

Parameters
----------
claim_id : str (required)
    The ID of the claim for which to retrieve transactions data.
page : int, optional
    The page number for paginated exposures (default: 1).
page_size : int, optional
    The number of exposures per page (default: 100, null for all).
transaction_types : list of str (optional)
    Filter by transaction type(s): reserve, payment, recovery, recovery_reserve
categories : list of str (optional)
    Filter by category(ies): loss, adjuster, legal, reinsurance, subrogation,
    salvage, reinsurancelae
statuses : list of str (optional)
    Filter by status(es): voided
payment_methods : list of str (optional)
    Filter by payment method(s): NoAuth, CC, ACH
date_from : str (optional)
    Filter transactions on or after this date (YYYY-MM-DD format)
date_to : str (optional)
    Filter transactions on or before this date (YYYY-MM-DD format)
sort_by : str (optional, default: "transaction_datetime")
    Field to sort by: transaction_datetime, amount, payee, transaction_category
sort_order : str (optional, default: "desc")
    Sort order: asc, desc

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    Human-readable messages.
data : dict
    Contains the transactions objects in the following format. Some fields could be missing if not relevant ::
        {
            'transactions': [
                {
                    'id': str,
                    'transaction_type': str,
                    'transaction_category': str,
                    'amount': Decimal,
                    'new_amount': Decimal,
                    'previous_amount': Decimal,
                    'exported': bool,
                    'exported_datetime': datetime,
                    'voided': bool,
                    'voided_datetime': datetime,
                    'transaction_datetime': datetime,
                    'modified_by_username': str,
                    'description': str,
                    'memo': str,
                    'recovery_category': str,
                    'contact_id': str,
                    'address_id': str,
                    'exposure_id': str,
                    'payee_ids': list of str,
                    'payment_classification': str,
                    'payment_method_account_name': str,
                    'payment_method_masked_number': str,
                    'payment_method': str,
                    'check_number': int,
                    'payees': [
                        {
                            'id': str,
                            'name': str
                        },
                        ...
                    ],
                    'modified_by': str,
                    'claim_level_transaction': bool,
                    'exposure_details': {
                        'id': str,
                        'claimant_name': str,
                        'coverage_name': str,
                        'loss_name': str,
                        'reinsurance_reserve': Decimal,
                        'reinsurancelae_reserve': Decimal,
                        'salvage_reserve': Decimal,
                        'subrogation_reserve': Decimal
                    }
                },
                ...
            ],
            "total_records": int
        }

Get a list of all perils

Code
Parameters
----------

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : list
    A list of peril dicts having the form:
    ::
        [
            {'aplus_code': str,
             'code': str,
             'date_updated': '2020-01-15 15:53:42',
             'id': str,
             'name': str}
        ]

Retrieve claim.

Code
Parameters
----------
claim_id : str
    The claim id
claim_number: str
    The claim number

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

Lists Claim Change log trails.

Code
Parameters
----------
from_date_time : datetime, optional
    Datetime range filter. Format: YYYY-MM-DD HH:MM:SS
to_date_time : datetime, optional
    Datetime range filter. Format: YYYY-MM-DD HH:MM:SS
transaction : str
    Transaction filter option
    Available Options [loss_reserve, claim_payment, status, loss_address,
                       policy, claimant, loss_cause, adjuster, date_reported,
                       loss_date, adjustment_reserve, coverage, legal_reserve, active,
                       named_insured, agent]
Raises
------
standard_error
    If from_date_time is incorrectly formatted
    If to_date_time is incorrectly formatted

Returns
-------
success : bool
    True if successful, false if not
messages : list
    List of human-readable error messages

Gets contacts for a given claim.

Code
Parameters
----------
claim_id : str, required
    The claim id.

Returns
-------
success : bool
    True if completely successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
{
    "publicClaimsAdjusters": [],
    "plaintiffAttorneys": [],
    "reinsurers": [],
    "publicAdjusters": [],
    "contractors": [],
    "selectedCoverage": str,
    "adjusters": [],
    "supervisors": [],
    "namedInsureds": [],
    "agents": [],
    "fireDepartments": [],
    "policeDepartments": [],
    "claimants": [],
    "mortgagees": [],
    "defendantAttorneys": [],
    "additionalInterests": [],
    "id": str,
    "medicalProviders": []
}

Each contact's non-empty ``data`` carries ``display_phone`` and ``display_email``: on adjuster, supervisor,
external adjuster, plaintiff attorney and defendant attorney rows, the Work entry of ``phoneNumbers`` /
``emailAddresses`` (else the first entry); null on every other row.

Get claim date types

Code
Returns
-------
success : bool
    True if successful, false if not
messages : list[str]
    List of human-readable error messages
data: dict
    One or more claim date types.
    ::
    {
        "<claim-date-type-name>": "<claim-date-type-label>",
        ...
    }

Get claim dates

Code
Parameters
----------
claim_id : str, required
    the claim id

Returns
-------
success : bool
    True if successful, false if not
messages : list[str]
    List of human-readable error messages
data: list[dict]
    One or more claim dates.
    ::
    [
        {
            "dateId": "<uuid>",
            "type": "<claim-date-type>",
            "dateString": "<mm/dd/YYYY>",
        },
        ...
    ]

Whether a claim is left out of the monthly ISO A-PLUS file.

Code
Parameters
----------
claim_id : str, required
    UUID of the claim.

Returns
-------
dict
    ``claim_id``; ``exclude_from_iso_aplus`` (True when another carrier reports the loss); ``can_update``,
    whether the caller may change it.

Raises
------
BCApiRequestPermissionDeniedError
    When the caller may not read the value.
NotFound
    When no claim exists for ``claim_id``.

The ISO A-PLUS transaction type of a claim.

Code
Parameters
----------
claim_id : str, required
    UUID of the claim.

Returns
-------
dict
    ``claim_id``; ``iso_transaction_type``, ``individual`` or ``business`` (a claim without one reads as
    ``individual``); ``can_update``, whether the caller may change it.

Raises
------
BCApiRequestPermissionDeniedError
    When the caller may not read the value.
NotFound
    When no claim exists for ``claim_id``.

Get a list of claims payments, including each payment's classification name as classification_type as well as selected payee names and addresses.

Code
Parameters
----------
include_exported : bool, (Defaults to False)
    Set to True to include exported payments.
include_voided : bool, (Defaults to False)
    Set to True to include voided payments.
classification_types : list, optional
    A list strings. Each string is the name of a claims payment
    classification to filter the results by. Defaults to all payment
    classifications (including null).

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : list
    A list of claim payment dicts having the form:
    ::
        [
            {
                'id': str,
                'address': {
                    "type": str,
                    "type_label": str or null,
                    "attention": str or null,
                    "address_line1": str,
                    "address_line2": str or null,
                    "address_city": str,
                    "address_county": str,
                    "address_state": str,
                    "address_country": str,
                    "address_zip": str
                }, # or null
                'amount': float,
                'check_date': str or null,
                'check_display': str or null,
                'check_number': int or null,
                'claim_id': str,
                'claim_number': str,
                'date_updated': str,
                'deductible': int,
                'description': str or null,
                'exported': bool,
                'classification_type': str or null,
                'payment_method_id': str,
                'type': 'payment',
                'historical': bool,
                'item_amounts': [
                    {
                        'legalPaid': str (Decimal),
                        'claimItemId': str,
                        'lineItemName': str,
                        'lossPaid': str (Decimal),
                        'adjustingPaid': str (Decimal)
                    },
                    ...
                ],
                'memo': str or null,
                'policy_number': str,
                'recovery_category': str or null,
                'reinsurance_contract_contact_id': str or null,
                'selected_payees': [
                    {
                        'name': str,
                        'addresses': [
                            {
                                "type": str,
                                "type_label": str or null,
                                "attention": str or null,
                                "address_line1": str,
                                "address_line2": str or null,
                                "address_city": str,
                                "address_county": str,
                                "address_state": str,
                                "address_country": str,
                                "address_zip": str
                            },
                            ...
                        ],  # or []
                    ...
                ],  # or []
                'transaction_date': str,
                'voided': bool,
                'voided_date': str or null,

Return the structured claim snapshot for the Claims Copilot.

Code
Projects the deterministic claim data the summary and insights
operations consume in one call: header, policy context, parties with
their roles, coverages filed against, recorded losses (properties,
injuries, vehicles), estimation assignments, notes, tasks, exposure
accounting, and document / note counts. No role-based redaction
(consumed via API key).

Parameters
----------
params : dict
    Request payload. Must contain ``claim_id`` (str).

Returns
-------
dict
    ``{"claim_id": <str>, "facts": {<grouped sections>}}`` where the
    grouped sections are ``claim``, ``policy``, ``parties``,
    ``coverages``, ``losses``, ``estimations``, ``notes``, ``tasks``,
    ``accounting``, and ``documents``.

Raises
------
NotFound
    When no claim exists for ``claim_id``.

Get comprehensive claims statistics and analytics.

Code
Returns statistics including:
- Summary metrics (active claims, percentages, averages)
- Claims by status (pie chart data - excludes Closed claims)
- Claims with open tasks summary
- Open tasks per assignee
- Tasks closed per day (last 30 days - histogram)
- Open vs closed claims per day (last month - histogram)
- Oldest open claims (risky claims)

This endpoint provides claims statistics that can be used by:
- AI agents (e.g., Claims Analytics) for analytics and insights
- Dashboard components for visualization
- Reporting and monitoring tools

Returns
-------
success : bool
    True if successful, false if not
messages : list[str]
    List of human-readable error messages
data : dict
    Claims statistics data containing:
    - summary: {active_claims, open_claims, open_claims_percentage,
               total_open_tasks, tasks_completed_30d, avg_tasks_per_day}
    - claims_by_status: [{status, count}, ...]
    - claims_with_open_tasks: [{claim_id, claim_number, open_task_count,
                                oldest_task_date, assignee}, ...]
    - tasks_per_assignee: [{assignee, open_task_count}, ...]
    - tasks_closed_per_day: [{date, count}, ...]
    - claims_flow_per_day: [{date, opened, closed}, ...]
    - oldest_open_claims: [{claim_id, claim_number, created_at,
                           age_days, open_tasks, adjuster}, ...]
    - metadata: {generated_at, date_range_tasks, date_range_claims_flow}

Retrieve claims UI tab visibility for a claim.

Code
Parameters
----------
claim_id : str, required
    UUID of the claim.

Returns
-------
success : bool
    True if successful, false if not.
messages : list[str]
    List of human-readable messages.
data : dict
    Visibility configuration for claims tabs.

Get claims summary for given contact IDs or contact external references.

Code
Parameters
----------
contact_ids : list of str, optional
    List of contact UUIDs
contact_external_refs : list of str, optional
    List of contact external system references
active : bool, optional
    Filter for active claims (default: True)
page : int, optional
    Page number (default: 1)
page_size : int, optional
    Number of records per page (default: 20)

Returns
-------
dict
    Dictionary containing claims list

Get claims count for given contact IDs or contact external references.

Code
Parameters
----------
contact_ids : list of str, optional
    List of contact UUIDs
contact_external_refs : list of str, optional
    List of contact external system references
active : bool, optional
    Filter for active claims (default: True)

Returns
-------
dict
    Dictionary containing claims count

Code
Return persisted Claims Search request/response history for a claim.

Create new claim by claim number

Code
Parameters
----------
claim_number : str, required
    the claim number
claim_number_origin : str
    the claim number origin. refer to the enum for more details.
policy_number : str
    the policy number

Returns
-------
success : bool
    True if successful, false if not
messages : list[str]
    List of human-readable error messages
data: dict
    UUID of the created or existing claim entry.
    ::
    {
        "id": "<uuid>"
    }

Remove claim.

Code
Parameters
----------
claim_id : str, required
    the claim id
hard_delete : bool
    True if hard delete, False if soft delete

Returns
-------
success : bool
    True if successful, false if not

Code
Trigger a manual Claims Search request.

This endpoint initiates a search against the installed integration for prior-loss
matching. The request is sent to Tray.io, which handles communication.
Results are returned asynchronously via the store_claims_search callback.

Automatically determines submission type: if a successful Initial request
already exists for this claim, submits a Research request; otherwise
submits an Initial request.

Parameters
----------
claim_id : str, required
    UUID of the claim to search

Returns
-------
success : bool
    True if the request was successfully scheduled
messages : list of str
    Human-readable messages
data : dict
    Response containing:
    - request_id: UUID for tracking/correlation
    - status: 'Scheduled' or 'Failed'
    - message: Human-readable status message (optional)
    - error_code: Error code if failed (optional)
    - error_message: Error details if failed (optional)

Code
Retrieve Claim Change Log entries.

Parameters
----------
filter_by : str, required
    The date field to filter by. One of the following:
        'date_stamp' - The date the change was made (in CST timezone).
        Supports time-based filtering if 'allow_timestamp' is set to True.
        'date_cursor' - The calculated date in effect. This typically equals to the date_stamp, except that:
            - It might be NULL when transaction=loss_date;
            - It might be different from date_stamp when transaction=status and changed_to is 'Closed', reflecting
        Does not support time-based filtering.
from_date : str, required
    The start date of the search.
    If allow_timestamp is True, includes the start time (format YYYY-mm-dd or YYYY-mm-dd HH:MM:SS)
to_date : str, required
    The end date of the search.
    If allow_timestamp is True, includes the end time (format YYYY-mm-dd or YYYY-mm-dd HH:MM:SS)
allow_timestamp : bool, optional
    If True and 'filter_by' is set to 'date_stamp', the 'from_date' and 'to_date' arguments
    will be treated as datetime with format 'YYYY-mm-dd HH:MM:SS'.
    If False or not provided, or if 'filter_by' is 'date_cursor', the 'from_date' and 'to_date'
    arguments will be treated as date with format 'YYYY-mm-dd'.
transactions : list of str, optional
    Limit the search to the specified transactions. Possible values include:
        {'policy', 'status', 'loss_date', 'loss_cause', 'loss_address', 'date_reported',
        'adjuster', 'claimant', 'active', 'coverage', 'party_removed',
        'loss_reserve', 'adjustment_reserve', 'legal_reserve', 'claim_payment', 'transaction'}
policy_type_ids : list of str, optional
    Limit the search to the specified policy types, based on the revision the claim is linked to.
claim_ids : list of str, optional
    Limit the search to the specified claims

Returns
-------
success : bool
    True if successful, False if not
data : dict
    Contains claim change log info
message : str
    Human-readable messages

Code
Given a valid transaction_date_from and transaction_date_to, return all claim payments that
match the given parameters.

Parameters
----------
policy_type_ids : list of str, optional
    List of policy type ids to filter the claim payments.
    The function will return only the claim payments that have a policy type id in this list.
transaction_date_from : str, required
    The start date for the transaction date range.
    The date should be in the format 'YYYY-mm-dd HH:MM:SS'.
transaction_date_to : str, required
    The end date for the transaction date range.
    The date should be in the format 'YYYY-mm-dd HH:MM:SS'.
exported : bool, optional
    If provided, the function will return only the claim payments that have the exported flag set to this value.
voided : bool, optional
    If provided, the function will return only the claim payments that have the voided flag set to this value.
historical : bool, optional
    If provided, the function will return only the claim payments that have the historical flag set to this value.

Returns
-------
success : bool
    True if the function executed successfully, false if there was an error.
messages : list of str
    List of human-readable error messages. If the function executed successfully, this list will be empty.
data : list of dict
    List of claim payment dictionaries, each containing all ClaimTransaction fields including:
    - system_tags: list of formatted system tag objects with 'id', 'name', and 'value' keys

Adds an address to a claim. This can be a property based address, or a non listed full address.

Code
Parameters
----------
claim_id : str, required
    UUID of the claim to add address. Format: YYYY-MM-DD HH:MM:SS
property_address_id: str, optional. If passed, set the address of the passed property id.
address : dict, optional
    dict containing address information.
    Data available to be sent:
        {
            'addressLine1': 'sample', 'addressLine2':  'sample',
            'addressCity': 'sample', 'addressState':  'MA',
            'addressZip': '01569'", 'addressCountyId': 'county UUID',
            'addressLatitude': 80.2,'addressLongitude': 70.1
        }
Raises
------
not found
    if claim is not found

Returns
-------
success : bool
    True if successful, false if not
data : json
    The updated claim

Code
Callback endpoint for receiving Claims Search results from Tray.io.

This endpoint receives asynchronous results from the Tray.io workflow
after Claims Search has processed the request. Results include
prior-loss matches that can be used for fraud detection.

Note: Phase 1 - Results are logged but not persisted to database.
Persistence will be added in Phase 3.

Parameters
----------
result : dict
    Callback data from Tray.io containing:
    - request_id: Correlation ID (matches original request)
    - status: 'Success', 'Failed', or 'Timeout'
    - vendor_reference_id: Claims Search file number (optional)
    - matches: List of prior-loss match records (optional)
    - error_code: Error code if failed (optional)
    - error_message: Error details if failed (optional)

Returns
-------
success : bool
    True if callback was processed successfully
messages : list of str
    Human-readable messages
data : dict
    Processing result with status and match count

Code
Find claims eligible for scheduled ISO ClaimSearch re-search, create
request records, and dispatch celery tasks to execute each one.

Called by Tray.io on a schedule.

Parameters
----------
integration_instance_id : str
    External ID of the integration instance as known by Tray.io (required)
research_interval_days : int
    Minimum days since last successful search (required)

Returns
-------
success : bool
data : dict
    triggered: int - number of research requests dispatched
    claims: list[dict] - {request_id, claim_id, claim_number} per request

Updates various fields on a claim.

Code
Parameters
----------
claim_id : UUID, required
    UUID of the Claim
status : str
    Status of the claim, Example: `Open, Subrogation`, `Open, Salvage` etc
perils : list
    List of peril UUIDs
catastrophe_id : UUID
    UUID of the Catastrophe
coverages : list
    List of coverages UUIDs

Raises
------
standard_error
    If claim_id is missing
    If claim_id is invalid
    If catastrophe_id is invalid
    If coverages has non zero reserve amounts
    If coverages has a payment has been applied against it

Returns
-------
success : bool
    True if successful, false if not
messages : list
    List of human-readable error messages

Update a claim date

Code
Parameters
----------
claim_id : str, required
    the claim id
claim_date_id : str, required
    the claim date id
claim_date_type : str, required
    the claim date type
claim_date : str, required
    the claim date (format: YYYY-mm-dd)

Returns
-------
success : bool
    True if successful, false if not
messages : list[str]
    List of human-readable error messages
data: dict
    The claim date.
    ::
    {
        "dateId": "<uuid>",
        "type": "<claim-date-type>",
        "dateString": "<mm/dd/YYYY>",
    }

Leave a claim out of the monthly ISO A-PLUS file, or report it again.

Code
A change writes one claim note; saving the current value writes none.

Parameters
----------
claim_id : str, required
    UUID of the claim.
exclude_from_iso_aplus : bool, required
    JSON ``true`` to leave the claim out, ``false`` to report it.

Returns
-------
dict
    The saved value, as ``get_claim_iso_aplus_reporting`` returns it.

Raises
------
BCApiRequestPermissionDeniedError
    When the caller may not change the value.
NotFound
    When no claim exists for ``claim_id``.

Change the ISO A-PLUS transaction type of a claim.

Code
A change writes one claim note; saving the current value writes none.

Parameters
----------
claim_id : str, required
    UUID of the claim.
iso_transaction_type : str, required
    ``individual`` or ``business``.

Returns
-------
dict
    The saved value, as ``get_claim_iso_aplus_transaction_type`` returns it.

Raises
------
BCApiRequestPermissionDeniedError
    When the caller may not change the value.
NotFound
    When no claim exists for ``claim_id``.

Code
Validate claim data for ClaimSearch submission without sending a request.

Builds the request payload and runs business-rule and schema validation,
returning any errors found. Use this endpoint to show the user what data
is missing before they attempt a manual search.

Parameters
----------
claim_id : str, required
    UUID of the claim to validate

Returns
-------
success : bool
    True if the request was processed (even if validation errors exist)
data : dict
    - valid: bool - True if the claim passes all validation rules
    - errors: list of str - human-readable validation messages