CsrSetPolicyDataByPolicyIdentifier models

DataSet models for CsrSetPolicyDataByPolicyIdentifier.

These typed dataclass models represent the tables and columns within the DataSet parameters for the CsrSetPolicyDataByPolicyIdentifier HQ operation.

IMPORTANT: Update operations require a GET first to populate the original_record field. HQ uses the unchanged row for optimistic concurrency checking.

Usage:

from q2_sdk.hq.hq_api.backoffice import CsrSetPolicyDataByPolicyIdentifier

q2_policy_generated_transaction_rights = CsrSetPolicyDataByPolicyIdentifier.Q2PolicyGeneratedTransactionRights(
    policy_identifier="...",
    short_name="...",
)

q2_policy_subsidiaries = CsrSetPolicyDataByPolicyIdentifier.Q2PolicySubsidiaries(
)

q2_policy_data = CsrSetPolicyDataByPolicyIdentifier.Q2PolicyData(
    policy_identifier="...",
    description="...",
)

q2_policy_object_groups = CsrSetPolicyDataByPolicyIdentifier.Q2PolicyObjectGroups(
    short_name="...",
    data="...",
    alias="...",
    object_group_type="...",
)

q2_policy_accounts = CsrSetPolicyDataByPolicyIdentifier.Q2PolicyAccounts(
    customer_account_id=1,
    host_account_id=1,
    customer_access=1,
    account_number_internal="...",
    status_description="...",
    product_type_name="...",
    product_name="...",
    is_external_account=True,
    product_type_id=1,
    product_id=1,
)

q2_policy_features = CsrSetPolicyDataByPolicyIdentifier.Q2PolicyFeatures(
    policy_identifier="...",
    enabled=True,
    property_name="...",
)

q2_policy_ach_class_codes = CsrSetPolicyDataByPolicyIdentifier.Q2PolicyAchClassCodes(
    ach_class_code="...",
)

class q2_sdk.hq.hq_api.backoffice.CsrSetPolicyDataByPolicyIdentifier_models.Q2PolicyGeneratedTransactionRights(policy_identifier='', transaction_type_id=None, short_name='', group_id=None, customer_id=None, company_id=None, user_role_id=None, user_id=None, enabled=None, authorize=None, cancel=None, create=None, create_restricted=None, update=None, view=None, limit_per_transaction=None, limit_per_day=None, limit_per_month=None, limit_per_acct_per_day=None, count_per_day=None, count_per_month=None, count_per_acct_per_day=None, dual_approval_limit=None, token_required_limit=None, draft_limit=None, rule_data=None, source_accounts=None, destination_accounts=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_PolicyGeneratedTransactionRights table.

policy_identifier: str = ''

transaction_type_id: int | None = None

short_name: str = ''

group_id: int | None = None

customer_id: int | None = None

company_id: int | None = None

user_role_id: int | None = None

user_id: int | None = None

enabled: bool | None = None

authorize: bool | None = None

cancel: bool | None = None

create: bool | None = None

create_restricted: bool | None = None

update: bool | None = None

view: int | None = None

limit_per_transaction: float | None = None

limit_per_day: float | None = None

limit_per_month: float | None = None

limit_per_acct_per_day: float | None = None

count_per_day: int | None = None

count_per_month: int | None = None

count_per_acct_per_day: int | None = None

dual_approval_limit: float | None = None

token_required_limit: float | None = None

draft_limit: float | None = None

rule_data: str | None = None

source_accounts: str | None = None

destination_accounts: str | None = None

original_record: Q2PolicyGeneratedTransactionRights | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2PolicyGeneratedTransactionRights

class q2_sdk.hq.hq_api.backoffice.CsrSetPolicyDataByPolicyIdentifier_models.Q2PolicySubsidiaries(policy_identifier=None, subsidiary_id=None, name=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_PolicySubsidiaries table.

policy_identifier: str | None = None

subsidiary_id: int | None = None

name: str | None = None

original_record: Q2PolicySubsidiaries | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2PolicySubsidiaries

class q2_sdk.hq.hq_api.backoffice.CsrSetPolicyDataByPolicyIdentifier_models.Q2PolicyData(policy_identifier='', policy_data_type=None, policy_type_id=None, description='', has_pending_change=None, rule_data=None, source_accounts=None, destination_accounts=None, create_date=None, last_edit_date=None, enabled=None, is_treasury=None, parent_policy_identifier=None, extended_description=None, is_template=None, is_open_banking=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_PolicyData table.

policy_identifier: str = ''

policy_data_type: str | None = None

policy_type_id: int | None = None

description: str = ''

has_pending_change: bool | None = None

rule_data: str | None = None

source_accounts: str | None = None

destination_accounts: str | None = None

create_date: str | None = None

last_edit_date: str | None = None

enabled: bool | None = None

is_treasury: bool | None = None

parent_policy_identifier: str | None = None

extended_description: str | None = None

is_template: bool | None = None

is_open_banking: bool | None = None

original_record: Q2PolicyData | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2PolicyData

class q2_sdk.hq.hq_api.backoffice.CsrSetPolicyDataByPolicyIdentifier_models.Q2PolicyObjectGroups(policy_identifier=None, object_group_id=-1, short_name='', customer_id=None, data='', alias='', object_group_type='', group_type_description=None, description=None, user_id=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_PolicyObjectGroups table.

policy_identifier: str | None = None

object_group_id: int = -1

short_name: str = ''

customer_id: int | None = None

data: str = ''

alias: str = ''

object_group_type: str = ''

group_type_description: str | None = None

description: str | None = None

user_id: int | None = None

original_record: Q2PolicyObjectGroups | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2PolicyObjectGroups

class q2_sdk.hq.hq_api.backoffice.CsrSetPolicyDataByPolicyIdentifier_models.Q2PolicyAccounts(policy_identifier=None, customer_account_id=0, host_account_id=0, customer_access=0, policy_reference_id=None, policy_access=None, account_number_internal='', account_number_external=None, account_desc=None, status_description='', product_type_name='', product_name='', aba=None, is_external_account=False, account_label=None, product_type_id=0, product_id=0, is_cdis_enabled=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_PolicyAccounts table.

policy_identifier: str | None = None

customer_account_id: int = 0

host_account_id: int = 0

customer_access: int = 0

policy_reference_id: int | None = None

policy_access: int | None = None

account_number_internal: str = ''

account_number_external: str | None = None

account_desc: str | None = None

status_description: str = ''

product_type_name: str = ''

product_name: str = ''

aba: str | None = None

is_external_account: bool = False

account_label: str | None = None

product_type_id: int = 0

product_id: int = 0

is_cdis_enabled: bool | None = None

original_record: Q2PolicyAccounts | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2PolicyAccounts

class q2_sdk.hq.hq_api.backoffice.CsrSetPolicyDataByPolicyIdentifier_models.Q2PolicyFeatures(policy_identifier='', user_property_data_id=None, group_id=None, customer_id=None, user_id=None, user_role_id=None, property_id=None, enabled=False, property_name='', category_short_name=None, category_description=None, allow_view=None, allow_edit=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_PolicyFeatures table.

policy_identifier: str = ''

user_property_data_id: int | None = None

group_id: int | None = None

customer_id: int | None = None

user_id: int | None = None

user_role_id: int | None = None

property_id: int | None = None

enabled: bool = False

property_name: str = ''

category_short_name: str | None = None

category_description: str | None = None

allow_view: bool | None = None

allow_edit: bool | None = None

original_record: Q2PolicyFeatures | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2PolicyFeatures

class q2_sdk.hq.hq_api.backoffice.CsrSetPolicyDataByPolicyIdentifier_models.Q2PolicyAchClassCodes(policy_identifier=None, ach_class_code='', original_record=None)[source]

Bases: object

Represents a row in the Q2_PolicyAchClassCodes table.

policy_identifier: str | None = None

ach_class_code: str = ''

original_record: Q2PolicyAchClassCodes | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2PolicyAchClassCodes

q2_sdk.hq.hq_api.backoffice.CsrSetPolicyDataByPolicyIdentifier_models.build_policy_data_dataset(q2_policy_generated_transaction_rights=None, q2_policy_subsidiaries=None, q2_policy_data=None, q2_policy_object_groups=None, q2_policy_accounts=None, q2_policy_features=None, q2_policy_ach_class_codes=None)[source]

Build the policy_data DataSet parameter for CsrSetPolicyDataByPolicyIdentifier.

For update operations, each model instance should have its original_record set to the pre-modification state (from a prior GET call).

For add operations, set auto-increment ID fields to negative values.

Return type:: DataSetBuilder
Returns:: DataSetBuilder ready to pass as the ‘policy_data’ parameter