Account

class q2_sdk.hq.models.account.Account(element=None, data_elements=None, provider_data=None, **kwargs)

Object representation of the Account information that comes in on a Q2 Online request

Typically created by passing in the XML shape provided by HQ. Also possible to build this by passing in kwargs.

ie. Account(element: lxmlElement) or Account(CifInternal="12345")

If both are provided, kwargs will override anything inside the given element

Parameters:

• element (Optional[Element]) – XML node form Q2 Online request

• data_elements (Optional[List[Element]]) – Optional list of Q2_AccountDataElement nodes.

• provider_data (Optional[dict]) – If the account originates from another system (such as a core), this can hold additional data that does not fit into the Q2 model.

• kwargs – Any items provided as kwargs will override the data passed in from element

property aba: str | None

property access: int | None

property acct_desc: str | None

property acct_label: str | None

property acct_number_internal: str | None

property acct_number_external: str | None

property acct_number_external_unmasked: str | None

property acct_number_internal_unmasked: str | None

property allow_interest: bool | None

property allow_principal: bool | None

property apr_or_apy: str | None

property balance1: Decimal | None

property balance2: Decimal | None

property balance_additional_desc1: str | None

property balance_additional_desc2: str | None

property balance_desc1: str | None

property balance_desc2: str | None

property balance_hade_name_to_use: str | None

property balance_name1: str | None

property balance_name2: str | None

property balance_to_disp_tran_to_desc: str | None

property balance_to_display: Decimal | None

property balance_to_display_desc: str | None

property balance_to_display_tran_to: Decimal | None

property balance_type1: str | None

property balance_type2: str | None

property calc_balance_for_history: bool | None

property calc_balance_for_memos: bool | None

property cif: str | None

property cif_internal: str | None

property cif_internal_unmasked: str | None

property cif_external: str | None

property cif_external_unmasked: str | None

property data_as_of_date: datetime | None

property default_pymt_amt_tran_from_desc: str | None

property default_tran_from_pymt_amt: Decimal | None

property display_order: int | None

property display_running_balance: bool | None

property has_pending_memos: bool | None

property history_count: int | None

property history_count_type: str | None

property host_acct_id: int | None

property hydra_product_code: str | None

property hydra_product_type_code: str | None

property is_external_acct: bool | None

property is_partial_details: bool | None

property link_type: str | None

property masked_cif_internal: str | None

property mob_dashboard_balance_desc: str | None

property mobility_dashboard_balance: Decimal | None

property nickname: str | None

property overview_acct_number: str

property product_id: int | None

property product_name: str | None

property product_type_id: int | None

property product_type_name: str | None

property product_type_voice_file: str | None

property product_voice_file: str | None

property sort_value: str | None

property status_short_name: str | None

property user_display_order: int

property user_id: int | None

property hade_dict: Dict[str, HADE]

Create a dict of HADE objects keyed by name for all data_elements that match the host_acct_id

property can_deposit: bool

Return bool indicating whether this account’s access level allows deposit

property can_view: bool

Return bool indicating whether this account’s access level allows view

property can_withdraw: bool

Return bool indicating whether this account’s access level allows withdrawal

property hydra_product_name: str

Returns a generic product name for the account

static from_json(data)

Return type:

Account

to_json()

Return type:

Dict[str, Any]