Lines Module API

API reference for policy line endpoints and line-level workflows.

BriteCore v2 Lines API endpoint wrappers.

Provides programmatic helpers for working with BriteCore line/policy export data.

Key functions:: get_export_line_file – Fetch export data for a specific line or policy type.

For interactive menu functionality, see britecore_sdk.utils.interactive_menu.

britecore_sdk.api.api_calls.v2.lines.create_effective_date(force=None, description=None, policy_type_external_system_references=None, effective_date=None, policy_type_ids=None, id=None, **kwargs)[source]

Create Effective Date.

POST /api/v2/lines/create_effective_date

Parameters:

force (bool | None)
description (str | None)
policy_type_external_system_references (list[str] | None)
effective_date (str | None)
policy_type_ids (list[str] | None)
id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.lines.create_policy_type(line=None, location_id=None, policy_type=None, effective_date_id=None, **kwargs)[source]

Create Policy Type.

POST /api/v2/lines/create_policy_type

Parameters:

line (Any | dict[str, Any] | None)
location_id (str | None)
policy_type (dict[str, Any] | None)
effective_date_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.lines.create_rating_grid_definition(name=None, location_id=None, type=None, **kwargs)[source]

Create Rating Grid Definition.

POST /api/v2/lines/create_rating_grid_definition

Parameters:

name (Any | None)
location_id (Any | None)
type (Any | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.lines.delete_effective_date(effective_date_id=None, **kwargs)[source]

Delete Effective Date.

POST /api/v2/lines/delete_effective_date

Parameters:

effective_date_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.lines.delete_policy_type(id=None, **kwargs)[source]

Delete Policy Type.

POST /api/v2/lines/delete_policy_type

Parameters:

id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.lines.delete_rating_table(sort_by=None, sort_order=None, id=None, page_size=None, page=None, **kwargs)[source]

Delete Rating Table.

POST /api/v2/lines/delete_rating_table

Parameters:

sort_by (str | None)
sort_order (str | None)
id (str | None)
page_size (int | None)
page (int | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.lines.delete_rating_table_file(**kwargs)[source]

Delete Rating Table File.

POST /api/v2/lines/delete_rating_table_file

Parameters:: kwargs (Unpack[RequestParameters])
Return type:: Any

britecore_sdk.api.api_calls.v2.lines.get_effective_date(effective_date_id=None, **kwargs)[source]

Get Effective Date.

POST /api/v2/lines/get_effective_date

Parameters:

effective_date_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.lines.get_policy_type(id=None, **kwargs)[source]

Get Policy Type.

POST /api/v2/lines/get_policy_type

Parameters:

id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.lines.get_rating_table_template(**kwargs)[source]

Get Rating Table Template.

POST /api/v2/lines/get_rating_table_template

Parameters:: kwargs (Unpack[RequestParameters])
Return type:: Any

britecore_sdk.api.api_calls.v2.lines.get_underwriting_question_autofill_answers(policy_type_id=None, **kwargs)[source]

Get Underwriting Question Autofill Answers.

POST /api/v2/lines/get_underwriting_question_autofill_answers

Parameters:

policy_type_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.lines.import_rating_table(location_id=None, **kwargs)[source]

Import Rating Table.

POST /api/v2/lines/import_rating_table

Parameters:

location_id (Any | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.lines.list_effective_dates(sort_order=None, page=None, page_size=None, **kwargs)[source]

List Effective Dates.

POST /api/v2/lines/list_effective_dates

Parameters:

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

Return type:

Any

britecore_sdk.api.api_calls.v2.lines.list_rating_grid_definitions(**kwargs)[source]

List Rating Grid Definitions.

POST /api/v2/lines/list_rating_grid_definitions

Parameters:: kwargs (Unpack[RequestParameters])
Return type:: Any

britecore_sdk.api.api_calls.v2.lines.list_rating_tables(**kwargs)[source]

List Rating Tables.

POST /api/v2/lines/list_rating_tables

Parameters:: kwargs (Unpack[RequestParameters])
Return type:: Any

britecore_sdk.api.api_calls.v2.lines.modify_effective_date(effective_date=None, force=None, id=None, description=None, **kwargs)[source]

Modify Effective Date.

POST /api/v2/lines/modify_effective_date

Parameters:

effective_date (str | None)
force (bool | None)
id (str | None)
description (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.lines.modify_policy_type(items=None, id=None, sub_lines=None, **kwargs)[source]

Modify Policy Type.

POST /api/v2/lines/modify_policy_type

Parameters:

items (list[dict[str, Any]] | None)
id (str | None)
sub_lines (list[dict[str, Any]] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.lines.retrieve_policy_type_claims_tabs_visibility(policy_type_id=None, **kwargs)[source]

Retrieve Policy Type Claims Tabs Visibility.

POST /api/v2/lines/retrieve_policy_type_claims_tabs_visibility

Parameters:

policy_type_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.lines.retrieve_rating_table(sort_by=None, sort_order=None, id=None, page_size=None, page=None, **kwargs)[source]

Retrieve Rating Table.

POST /api/v2/lines/retrieve_rating_table

Parameters:

sort_by (str | None)
sort_order (str | None)
id (str | None)
page_size (int | None)
page (int | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.lines.retrieve_underwriting_questions(policy_type_id=None, effective_date_id=None, **kwargs)[source]

Retrieve Underwriting Questions.

POST /api/v2/lines/retrieve_underwriting_questions

Parameters:

policy_type_id (str | None)
effective_date_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.lines.update_policy_type_claims_tab_visibility(policy_type_id=None, flagged=None, code_value_type=None, **kwargs)[source]

Update Policy Type Claims Tab Visibility.

POST /api/v2/lines/update_policy_type_claims_tab_visibility

Parameters:

policy_type_id (str | None)
flagged (bool | None)
code_value_type (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.lines.update_rating_table(id=None, file_id=None, **kwargs)[source]

Update Rating Table.

POST /api/v2/lines/update_rating_table

Parameters:

id (str | None)
file_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any