Deliverables Module API

API reference for deliverable retrieval and processing helpers.

BriteCore v2 Deliverables API endpoint wrappers.

This module provides wrappers for deliverable attachment lookups and e-deliverable retrieval in the BriteCore v2 deliverables API.

britecore_sdk.api.api_calls.v2.deliverables.delete_html_template(name=None, **kwargs)[source]

Delete HTML template by name.

POST /api/v2/deliverables/delete_html_template

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.deliverables.delete_static_resource(name=None, **kwargs)[source]

Delete static resource by name.

POST /api/v2/deliverables/delete_static_resource

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.deliverables.expire_all_static_resources(**kwargs)[source]

Expire all static resources.

POST /api/v2/deliverables/expire_all_static_resources

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.deliverables.expire_static_resource(name=None, **kwargs)[source]

Expire static resource by name.

POST /api/v2/deliverables/expire_static_resource

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.deliverables.getdeliverabledata(coverage_forms=None, invoice_id=None, date_cursor=None, reason=None, state_id=None, revision_id=None, return_data=None, deliverable_type=None, **kwargs)[source]

Get deliverable data.

POST /api/v2/deliverables/getDeliverableData

Parameters:

  • coverage_forms (list[str] | None)

  • invoice_id (str | None)

  • date_cursor (str | None)

  • reason (str | None)

  • state_id (str | None)

  • revision_id (str | None)

  • return_data (bool | None)

  • deliverable_type (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.deliverables.get_all_html_templates(**kwargs)[source]

Get all HTML templates.

POST /api/v2/deliverables/get_all_html_templates

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.deliverables.get_all_static_resources(**kwargs)[source]

Get all static resources.

POST /api/v2/deliverables/get_all_static_resources

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.deliverables.get_dec(revision_id=None, reason=None, policy_id=None, **kwargs)[source]

Get DEC document.

POST /api/v2/deliverables/get_dec

Parameters:

  • revision_id (str | None)

  • reason (str | None)

  • policy_id (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.deliverables.get_dynamic_fields(deliverable_template_id=None, **kwargs)[source]

Get dynamic fields for deliverable template.

POST /api/v2/deliverables/get_dynamic_fields

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.deliverables.get_edeliverables_by_id(ids=None, **kwargs)[source]

Get e-deliverables by identifiers.

POST /api/v2/deliverables/get_edeliverables_by_id

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.deliverables.get_html_template(name=None, **kwargs)[source]

Get HTML template by name.

POST /api/v2/deliverables/get_html_template

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.deliverables.get_pending_email_count(from_date=None, to_date=None, **kwargs)[source]

Get pending email count for date range.

POST /api/v2/deliverables/get_pending_email_count

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.deliverables.get_static_resource(name=None, **kwargs)[source]

Get static resource by name.

POST /api/v2/deliverables/get_static_resource

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.deliverables.index_edelivery_records(date_from=None, date_to=None, **kwargs)[source]

Index e-delivery records for date range.

POST /api/v2/deliverables/index_edelivery_records

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.deliverables.regenerate_combined_billing_statements(force_generation=None, start_date=None, end_date=None, group_billing_number=None, **kwargs)[source]

Regenerate combined billing statements.

POST /api/v2/deliverables/regenerate_combined_billing_statements

Parameters:

  • force_generation (Any | None)

  • start_date (Any | None)

  • end_date (Any | None)

  • group_billing_number (Any | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.deliverables.remove_edelivery_records(date_from=None, date_to=None, **kwargs)[source]

Remove e-delivery records for date range.

POST /api/v2/deliverables/remove_edelivery_records

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.deliverables.retrieve_available_document_options(location_abbr=None, location_name=None, location_id=None, module=None, **kwargs)[source]

Retrieve available document options.

POST /api/v2/deliverables/retrieve_available_document_options

Parameters:

  • location_abbr (str | None)

  • location_name (str | None)

  • location_id (str | None)

  • module (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.deliverables.retrieve_files_for_entity(field=None, advanced_filters=None, success=None, allow_null_reference=None, policy_number=None, messages=None, ascending=None, claim_number=None, Returns=None, reference_id=None, data=None, **kwargs)[source]

Retrieve files for entity.

POST /api/v2/deliverables/retrieve_files_for_entity

Parameters:

  • field (str | None)

  • advanced_filters (list[str] | None)

  • success (bool | None)

  • allow_null_reference (bool | None)

  • policy_number (str | None)

  • messages (list[str] | None)

  • ascending (bool | None)

  • claim_number (str | None)

  • Returns (str | None)

  • reference_id (str | None)

  • data (list[str] | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.deliverables.retrieve_invoice_document(invoice_number=None, primary_insured=None, **kwargs)[source]

Retrieve invoice document.

POST /api/v2/deliverables/retrieve_invoice_document

Parameters:

  • invoice_number (str | None)

  • primary_insured (bool | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.deliverables.save_html_template(show_as_custom_deliverable=None, name=None, enabled=None, use_new_pdf_render=None, use_new_html_render=None, html=None, **kwargs)[source]

Save HTML template.

POST /api/v2/deliverables/save_html_template

Parameters:

  • show_as_custom_deliverable (bool | None)

  • name (str | None)

  • enabled (bool | None)

  • use_new_pdf_render (bool | None)

  • use_new_html_render (bool | None)

  • html (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.deliverables.save_static_resource(url=None, expire_in=None, name=None, **kwargs)[source]

Save static resource.

POST /api/v2/deliverables/save_static_resource

Parameters:

  • url (str | None)

  • expire_in (int | None)

  • name (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.deliverables.set_html_templates_locations(messages=None, data=None, success=None, **kwargs)[source]

Set HTML templates locations.

POST /api/v2/deliverables/set_html_templates_locations

Parameters:

  • messages (list[str] | dict[str, Any] | None)

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

  • success (bool | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.deliverables.update_edelivery_records(records=None, **kwargs)[source]

Update e-delivery records.

POST /api/v2/deliverables/update_edelivery_records

Parameters:
Return type:

Any