Claims Module API

API reference for claim administration endpoints.

BriteCore v2 Claims API endpoint wrappers.

This module provides the SDK wrapper for retrieving claim details from the BriteCore v2 claims API.

britecore_sdk.api.api_calls.v2.claims.export_claim_payments(claim_ids=None, **kwargs)[source]

Export claim payments for one or more claim identifiers.

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.claims.get_all_catastrophes(**kwargs)[source]

Retrieve all catastrophe records available to the claims domain.

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claims.get_all_perils(**kwargs)[source]

Retrieve all peril records available to the claims domain.

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claims.get_claim(claim_id=None, claim_number=None, **kwargs)[source]

Retrieve claim details by claim identifier.

POST /api/v2/claims/get_claim

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.claims.get_claim_contacts(claim_id=None, **kwargs)[source]

Retrieve contacts associated with a claim.

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.claims.get_claim_payments(claim_id=None, **kwargs)[source]

Retrieve payment records associated with a claim.

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.claims.update_claim(claim_id=None, claim=None, **kwargs)[source]

Update claim fields for the provided claim identifier.

Parameters:

  • claim_id (str | None)

  • claim (dict[str, Any] | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claims.auto_assign_claim(claim_id=None, **kwargs)[source]

Auto Assign Claim.

POST /api/v2/claims/auto_assign_claim

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.claims.bifurcate_claim(claim_id=None, **kwargs)[source]

Bifurcate Claim.

POST /api/v2/claims/bifurcate_claim

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.claims.bulk_assign(**kwargs)[source]

Bulk Assign.

POST /api/v2/claims/bulk_assign

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claims.bulk_reassign(**kwargs)[source]

Bulk Reassign.

POST /api/v2/claims/bulk_reassign

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claims.bulk_unassign(**kwargs)[source]

Bulk Unassign.

POST /api/v2/claims/bulk_unassign

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claims.create_claim_date(claim_id=None, claim_date_type=None, claim_date=None, **kwargs)[source]

Create Claim Date.

POST /api/v2/claims/create_claim_date

Parameters:

  • claim_id (str | None)

  • claim_date_type (str | None)

  • claim_date (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claims.export_batch_claims(claim_ids=None, **kwargs)[source]

Export Batch Claims.

POST /api/v2/claims/export_batch_claims

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.claims.get_all_associated_claims_parties(claim_id=None, **kwargs)[source]

Get All Associated Claims Parties.

POST /api/v2/claims/get_all_associated_claims_parties

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.claims.get_all_claim_transactions(claim_id=None, page=None, page_size=None, **kwargs)[source]

Get All Claim Transactions.

POST /api/v2/claims/get_all_claim_transactions

Parameters:

  • claim_id (str | None)

  • page (int | None)

  • page_size (int | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claims.get_claim_change_logs(transaction=None, standard_error=None, to_date_time=None, Raises=None, from_date_time=None, field=None, **kwargs)[source]

Get Claim Change Logs.

POST /api/v2/claims/get_claim_change_logs

Parameters:

  • transaction (str | None)

  • standard_error (str | None)

  • to_date_time (str | None)

  • Raises (str | None)

  • from_date_time (str | None)

  • field (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claims.get_claim_date_types(claim_id=None, **kwargs)[source]

Get Claim Date Types.

POST /api/v2/claims/get_claim_date_types

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.claims.get_claim_dates(claim_id=None, **kwargs)[source]

Get Claim Dates.

POST /api/v2/claims/get_claim_dates

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.claims.get_claims_tabs_visibility(claim_id=None, **kwargs)[source]

Get Claims Tabs Visibility.

POST /api/v2/claims/get_claims_tabs_visibility

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.claims.get_contacts_claims(active=None, contact_external_refs=None, contact_ids=None, page=None, page_size=None, **kwargs)[source]

Get Contacts Claims.

POST /api/v2/claims/get_contacts_claims

Parameters:

  • active (bool | None)

  • contact_external_refs (list[str] | None)

  • contact_ids (list[str] | None)

  • page (int | None)

  • page_size (int | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claims.get_contacts_claims_count(active=None, contact_external_refs=None, contact_ids=None, **kwargs)[source]

Get Contacts Claims Count.

POST /api/v2/claims/get_contacts_claims_count

Parameters:

  • active (bool | None)

  • contact_external_refs (list[str] | None)

  • contact_ids (list[str] | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claims.new_claim(claim_number=None, claim_number_origin=None, policy_number=None, **kwargs)[source]

New Claim.

POST /api/v2/claims/new_claim

Parameters:

  • claim_number (str | None)

  • claim_number_origin (str | None)

  • policy_number (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claims.remove_claim(hard_delete=None, claim_id=None, **kwargs)[source]

Remove Claim.

POST /api/v2/claims/remove_claim

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.claims.retrieve_claim_change_logs(claim_ids=None, transactions=None, filter_by=None, allow_timestamp=None, from_date=None, to_date=None, policy_type_ids=None, **kwargs)[source]

Retrieve Claim Change Logs.

POST /api/v2/claims/retrieve_claim_change_logs

Parameters:

  • claim_ids (list[str] | None)

  • transactions (list[str] | None)

  • filter_by (str | None)

  • allow_timestamp (bool | None)

  • from_date (str | None)

  • to_date (str | None)

  • policy_type_ids (list[str] | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claims.retrieve_claim_payments(transaction_date_from=None, voided=None, exported=None, historical=None, policy_type_ids=None, transaction_date_to=None, **kwargs)[source]

Retrieve Claim Payments.

POST /api/v2/claims/retrieve_claim_payments

Parameters:

  • transaction_date_from (str | None)

  • voided (bool | None)

  • exported (bool | None)

  • historical (bool | None)

  • policy_type_ids (list[str] | None)

  • transaction_date_to (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claims.set_claim_loss_address(not_found=None, Raises=None, address=None, field=None, claim_id=None, property_address_id=None, **kwargs)[source]

Set Claim Loss Address.

POST /api/v2/claims/set_claim_loss_address

Parameters:

  • not_found (str | None)

  • Raises (str | None)

  • address (dict[str, Any] | None)

  • field (str | None)

  • claim_id (str | None)

  • property_address_id (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claims.update_claim_date(claim_date_id=None, claim_id=None, claim_date_type=None, claim_date=None, **kwargs)[source]

Update Claim Date.

POST /api/v2/claims/update_claim_date

Parameters:

  • claim_date_id (str | None)

  • claim_id (str | None)

  • claim_date_type (str | None)

  • claim_date (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any