Claim Exposures Module API

API reference for claim exposure helpers.

BriteCore V2 claim_exposures API endpoint wrappers.

britecore_sdk.api.api_calls.v2.claim_exposures.add_recovery(claim_id=None, recovery_details=None, api_key=None, page=None, page_size=None, reserve_details=None, exposure_id=None, payment_details=None, **kwargs)[source]

Add recovery information to a claim exposure.

POST /api/v2/claim_exposures/add_recovery

Parameters:

claim_id (str | None)
recovery_details (dict[str, Any] | None)
api_key (str | None)
page (int | None)
page_size (int | None)
reserve_details (Any | None)
exposure_id (Any | None)
payment_details (Any | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claim_exposures.add_recovery_reserve(claim_id=None, api_key=None, recovery_reserve_details=None, page=None, page_size=None, **kwargs)[source]

Add recovery reserve to a claim exposure.

POST /api/v2/claim_exposures/add_recovery_reserve

Parameters:

claim_id (str | None)
api_key (str | None)
recovery_reserve_details (dict[str, Any] | None)
page (int | None)
page_size (int | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claim_exposures.add_reserve(claim_id=None, page=None, page_size=None, **kwargs)[source]

Add reserve to a claim exposure.

POST /api/v2/claim_exposures/add_reserve

Parameters:

claim_id (str | None)
page (int | None)
page_size (int | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claim_exposures.create_exposure(claim_id=None, page=None, page_size=None, **kwargs)[source]

Create a new claim exposure.

POST /api/v2/claim_exposures/create_exposure

Parameters:

claim_id (str | None)
page (int | None)
page_size (int | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claim_exposures.delete_exposure(claim_id=None, page=None, page_size=None, **kwargs)[source]

Delete a claim exposure.

POST /api/v2/claim_exposures/delete_exposure

Parameters:

claim_id (str | None)
page (int | None)
page_size (int | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claim_exposures.get_accounting_data(claim_id=None, page=None, page_size=None, **kwargs)[source]

Retrieve accounting data for a claim.

POST /api/v2/claim_exposures/get_accounting_data

Parameters:

claim_id (str | None)
page (int | None)
page_size (int | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claim_exposures.get_accounting_loss_details(api_key=None, claim_id=None, page=None, page_size=None, **kwargs)[source]

Retrieve accounting loss details for a claim.

POST /api/v2/claim_exposures/get_accounting_loss_details

Parameters:

api_key (str | None)
claim_id (str | None)
page (int | None)
page_size (int | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claim_exposures.get_accounting_overview(api_key=None, claim_id=None, page=None, page_size=None, **kwargs)[source]

Retrieve accounting overview for a claim.

POST /api/v2/claim_exposures/get_accounting_overview

Parameters:

api_key (str | None)
claim_id (str | None)
page (int | None)
page_size (int | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claim_exposures.get_accounting_recoveries_data(api_key=None, claim_id=None, page=None, page_size=None, **kwargs)[source]

Retrieve accounting recovery data for a claim.

POST /api/v2/claim_exposures/get_accounting_recoveries_data

Parameters:

api_key (str | None)
claim_id (str | None)
page (int | None)
page_size (int | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claim_exposures.get_broken_limits(claim_id=None, instance=None, type=None, page=None, page_size=None, **kwargs)[source]

Retrieve broken coverage limits for a claim.

POST /api/v2/claim_exposures/get_broken_limits

Parameters:

claim_id (str | None)
instance (Any | None)
type (Any | None)
page (int | None)
page_size (int | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claim_exposures.get_coverage_accounting_data(claim_id=None, page=None, page_size=None, **kwargs)[source]

Retrieve coverage accounting data for a claim.

POST /api/v2/claim_exposures/get_coverage_accounting_data

Parameters:

claim_id (str | None)
page (int | None)
page_size (int | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claim_exposures.get_exposure_accounting_data(claim_id=None, page=None, page_size=None, **kwargs)[source]

Retrieve exposure accounting data for a claim.

POST /api/v2/claim_exposures/get_exposure_accounting_data

Parameters:

claim_id (str | None)
page (int | None)
page_size (int | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claim_exposures.get_exposure_transactions(claim_id=None, page=None, page_size=None, **kwargs)[source]

Retrieve transactions for a claim exposure.

POST /api/v2/claim_exposures/get_exposure_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.claim_exposures.get_payment(claim_id=None, payment_id=None, page=None, page_size=None, **kwargs)[source]

Retrieve payment details for a claim exposure.

POST /api/v2/claim_exposures/get_payment

Parameters:

claim_id (str | None)
payment_id (str | None)
page (int | None)
page_size (int | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claim_exposures.list_exposures(claim_id=None, page=None, page_size=None, **kwargs)[source]

List all exposures for a claim.

POST /api/v2/claim_exposures/list_exposures

Parameters:

claim_id (str | None)
page (int | None)
page_size (int | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claim_exposures.make_multi_exposures_payment(claim_id=None, page=None, page_size=None, **kwargs)[source]

Make payment across multiple exposures for a claim.

POST /api/v2/claim_exposures/make_multi_exposures_payment

Parameters:

claim_id (str | None)
page (int | None)
page_size (int | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claim_exposures.make_payment(claim_id=None, page=None, page_size=None, **kwargs)[source]

Make payment for a claim exposure.

POST /api/v2/claim_exposures/make_payment

Parameters:

claim_id (str | None)
page (int | None)
page_size (int | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claim_exposures.update_payment(claim_id=None, payment_details=None, page=None, page_size=None, **kwargs)[source]

Update payment information for a claim exposure.

POST /api/v2/claim_exposures/update_payment

Parameters:

claim_id (str | None)
payment_details (dict[str, Any] | None)
page (int | None)
page_size (int | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.claim_exposures.void_transaction(claim_id=None, page=None, page_size=None, **kwargs)[source]

Void a transaction for a claim exposure.

POST /api/v2/claim_exposures/void_transaction

Parameters:

claim_id (str | None)
page (int | None)
page_size (int | None)
kwargs (Unpack[RequestParameters])

Return type:

Any