AccountList

class q2_sdk.hq.models.account_list.AccountList(accounts=None, account_filter=None)[source]

Object for holding multiple Account objects. Provides search options.

property filtered_accounts: List[T]

self.accounts after self.account_filter is applied

get_by_account_number(acct_num)[source]

Return account with given acct_number_internal_unmasked

Return type:

TypeVar(T, Account, SSOAccount)

filter_by_cif(cif)[source]

Return accounts with given cif

Return type:

List[TypeVar(T, Account, SSOAccount)]

property filtered_cifs: List[str]

CIFs of accounts in self.filtered_accounts

property filtered_account_numbers: List[str]

Acct Numbers of accounts in self.filtered_accounts

get_host_acct_id_list(cif=None, account_number=None)[source]
Parameters:

cif – If provided, will limit the result by cif

AccountFilter

class q2_sdk.hq.models.account_list.AccountFilter(min_access_level=0, product_type_code_filter=None, product_name_filter=None, use_external_accounts=AccountType.All, **kwargs)[source]

Meant for use with AccountList object

Parameters:
  • min_access_level (int) – Integer representing deposit/view/withdraw access: 0: No rights, 7: View, Deposit, and Withdraw Rights

  • product_type_code_filter (List) – List of hydra_product_type_code to filter by

  • product_name_filter (List[str]) – List of hydra product names to filter by

  • account_types – AccountType Enum value: External, Internal, or All