Utils Module API

API reference for general utility endpoints.

BriteCore v2 Utils API endpoint wrappers.

Provides administrative and system-utility helpers that don’t belong to a specific business domain.

britecore_sdk.api.api_calls.v2.utils.add_britedocs_reference(report_type_name=None, britedocs_id=None, location_name=None, product_name=None, x_report_location_id=None, **kwargs)[source]

Add Britedocs Reference.

POST /api/v2/utils/add_britedocs_reference

Parameters:

  • report_type_name (str | None)

  • britedocs_id (str | None)

  • location_name (str | None)

  • product_name (str | None)

  • x_report_location_id (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.utils.generate_receipt(payment_id=None, **kwargs)[source]

Generate Receipt.

POST /api/v2/utils/generate_receipt

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.utils.get_effective_dates(**kwargs)[source]

Get Effective Dates.

POST /api/v2/utils/get_effective_dates

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

Get Navigation Links.

POST /api/v2/utils/get_navigation_links

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.utils.get_policies(include_policy_photo=None, page_size=None, from_date=None, page_number=None, to_date=None, sorting_order=None, contact_id=None, include_canceled=None, **kwargs)[source]

Get Policies.

POST /api/v2/utils/get_policies

Parameters:

  • include_policy_photo (Any | None)

  • page_size (Any | None)

  • from_date (Any | None)

  • page_number (Any | None)

  • to_date (Any | None)

  • sorting_order (Any | None)

  • contact_id (Any | None)

  • include_canceled (Any | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.utils.get_policies_by_contact_id_db_query(contact_id=None, **kwargs)[source]

Get Policies By Contact Id Db Query.

POST /api/v2/utils/get_policies_by_contact_id_db_query

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.utils.get_policies_with_active_current_revision(include_canceled=None, policies=None, **kwargs)[source]

Get Policies With Active Current Revision.

POST /api/v2/utils/get_policies_with_active_current_revision

Parameters:

  • include_canceled (Any | None)

  • policies (Any | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.utils.get_signable_deliverable_names(**kwargs)[source]

Get Signable Deliverable Names.

POST /api/v2/utils/get_signable_deliverable_names

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.utils.is_insured_mentioned_on_current_revision(candidate_policy=None, insured_contact_id=None, **kwargs)[source]

Is Insured Mentioned On Current Revision.

POST /api/v2/utils/is_insured_mentioned_on_current_revision

Parameters:

  • candidate_policy (Any | None)

  • insured_contact_id (Any | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.utils.mark_file_as_signed(file_id=None, **kwargs)[source]

Mark File As Signed.

POST /api/v2/utils/mark_file_as_signed

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.utils.mark_return_premium_or_claim_payment_as_exported_with_check_details(records_to_export_dict_required=None, table_name=None, **kwargs)[source]

Mark Return Premium Or Claim Payment As Exported With Check Details.

POST /api/v2/utils/mark_return_premium_or_claim_payment_as_exported_with_check_details

Parameters:

  • records_to_export_dict_required (str | None)

  • table_name (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.utils.meta(**kwargs)[source]

Meta.

POST /api/v2/utils/meta

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.utils.refund(transfer_policy_number=None, refund_reason=None, policy_term_id=None, refund_amount=None, policy_number=None, **kwargs)[source]

Refund.

POST /api/v2/utils/refund

Parameters:

  • transfer_policy_number (str | None)

  • refund_reason (str | None)

  • policy_term_id (str | None)

  • refund_amount (float | int | None)

  • policy_number (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.utils.retrieve_background_job(job_id=None, **kwargs)[source]

Retrieve Background Job.

POST /api/v2/utils/retrieve_background_job

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.utils.retrieve_payments_on_policy(only_missing_receipts=None, policy_number=None, **kwargs)[source]

Retrieve Payments On Policy.

POST /api/v2/utils/retrieve_payments_on_policy

Parameters:

  • only_missing_receipts (bool | None)

  • policy_number (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.utils.retrieve_receipts(number=None, **kwargs)[source]

Retrieve Receipts.

POST /api/v2/utils/retrieve_receipts

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.utils.revert_agentcy_transfer(archive_id=None, **kwargs)[source]

Revert Agentcy Transfer.

POST /api/v2/utils/revert_agentcy_transfer

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.utils.revert_mortgagee_transfer(archive_id=None, **kwargs)[source]

Revert Mortgagee Transfer.

POST /api/v2/utils/revert_mortgagee_transfer

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.utils.transfer_agentcy_policies(effective_date=None, print_decs=None, to_contact_id=None, from_contact_id=None, **kwargs)[source]

Transfer Agentcy Policies.

POST /api/v2/utils/transfer_agentcy_policies

Parameters:

  • effective_date (str | None)

  • print_decs (bool | None)

  • to_contact_id (str | None)

  • from_contact_id (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.utils.transfer_mortgagee_policies(effective_date=None, to_contact_id=None, from_contact_id=None, **kwargs)[source]

Transfer Mortgagee Policies.

POST /api/v2/utils/transfer_mortgagee_policies

Parameters:

  • effective_date (str | None)

  • to_contact_id (str | None)

  • from_contact_id (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.utils.unarchive_record(db_table=None, unique_value=None, **kwargs)[source]

Unarchive Record.

POST /api/v2/utils/unarchive_record

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.utils.update_revision(action=None, revision_id=None, **kwargs)[source]

Update Revision.

POST /api/v2/utils/update_revision

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.utils.update_search_index(identifiers=None, index_name=None, **kwargs)[source]

Update Search Index.

POST /api/v2/utils/update_search_index

Parameters:

  • identifiers (list[str] | None)

  • index_name (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.utils.validate_and_clean_claim_numbers_list(claim_numbers_list=None, **kwargs)[source]

Validate And Clean Claim Numbers List.

POST /api/v2/utils/validate_and_clean_claim_numbers_list

Parameters:
Return type:

Any