Return Premium Module API

API reference for return premium processing helpers.

BriteCore v2 Return Premium API endpoint wrappers.

This module provides the SDK wrapper for exporting return premium records from the BriteCore v2 return premium API.

britecore_sdk.api.api_calls.v2.return_premium.exportreturnpremium(return_premium_id=None, **kwargs)[source]

Export a return premium record by identifier.

POST /api/v2/return_premium/exportReturnPremium

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.return_premium.retrieve_return_premiums(authorized=None, transferred=None, rejected=None, voided=None, canceled=None, from_date=None, exported=None, policy_type_ids=None, to_date=None, **kwargs)[source]

Retrieve Return Premiums.

POST /api/v2/return_premium/retrieve_return_premiums

Parameters:

  • authorized (bool | None)

  • transferred (bool | None)

  • rejected (bool | None)

  • voided (bool | None)

  • canceled (bool | None)

  • from_date (str | None)

  • exported (bool | None)

  • policy_type_ids (list[str] | None)

  • to_date (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any