GetUserAccountList module

Get a users account list, DesiredHydraProductCodes is pipe delimited list 2 char values of HydraProductTypeCode+HydraProductCode, with * allowed in HydraProductCode (D*|L*|C* for all deposit, loan and credit accounts)

Sample response (may differ slightly in your environment)

<Q2API HqVersion="4.2.3.4215A" HqAssemblyVersion="4.2.6185.31252" ServerDateTime="2017-11-21T08:10:34.7386896-06:00">
  <Result>
    <ErrorCode ErrorType="Success">0</ErrorCode>
    <ErrorDescription/>
    <HydraErrorReturnCode>0</HydraErrorReturnCode>
  </Result>
  <Data>
    <AccountListResponse>
      <AccountListResponseRecord>
        <UserID>1</UserID>
        <HostAccountID>5000</HostAccountID>
        <AccountNumberInternal>XXXXXX3467</AccountNumberInternal>
        <ProductTypeName>Deposit</ProductTypeName>
        <ProductName>Regular Checking</ProductName>
        <AccountDesc>Checking</AccountDesc>
        <NickName>Online Display Checking</NickName>
        <LinkType>A</LinkType>
        <DisplayOrder>1</DisplayOrder>
        <Balance1>389.49</Balance1>
        <BalanceDescription1>Available Balance</BalanceDescription1>
        <BalanceName1>AvailBal</BalanceName1>
        <BalanceType1>Currency</BalanceType1>
        <Balance2>389.49</Balance2>
        <BalanceDescription2>Current Balance</BalanceDescription2>
        <BalanceName2>CurBal</BalanceName2>
        <BalanceType2>Currency</BalanceType2>
        <ProductTypeVoiceFile>deposit.wav</ProductTypeVoiceFile>
        <ProductVoiceFile>regularChecking.wav</ProductVoiceFile>
        <HydraProductCode>C</HydraProductCode>
        <HydraProductTypeCode>D</HydraProductTypeCode>
        <DataAsOfDate>2017-05-25T10:43:18.847-05:00</DataAsOfDate>
        <APRorAPY>Y</APRorAPY>
        <Access>7</Access>
        <ProductID>1</ProductID>
        <ProductTypeID>1</ProductTypeID>
        <AllowPrincipal>false</AllowPrincipal>
        <AllowInterest>false</AllowInterest>
        <DisplayRunningBalance>false</DisplayRunningBalance>
        <CalculateRunningBalanceForyHistory>false</CalculateRunningBalanceForyHistory>
        <CalculateRunningBalanceForMemos>false</CalculateRunningBalanceForMemos>
        <RunningBalanceHadeNameToUse>CurBal</RunningBalanceHadeNameToUse>
        <HistoryCount>50</HistoryCount>
        <HistoryCountType>Items</HistoryCountType>
        <HasPendingMemos>false</HasPendingMemos>
        <IsExternalAccount>false</IsExternalAccount>
        <UserDisplayOrder>0</UserDisplayOrder>
        <BalanceToDisplay>389.49</BalanceToDisplay>
        <SortValue/>
        <Cif>HQ_Test_1428315</Cif>
        <MobilityDashboardBalance>389.49</MobilityDashboardBalance>
        <BalanceAdditionalDescription1>Available Balance</BalanceAdditionalDescription1>
        <BalanceAdditionalDescription2>Current Balance</BalanceAdditionalDescription2>
        <BalanceToDisplayTransferTo>389.49</BalanceToDisplayTransferTo>
        <DefaultPaymentAmountTransferFrom>389.49</DefaultPaymentAmountTransferFrom>
        <BalanceToDisplayDescription>Available Balance</BalanceToDisplayDescription>
        <MobilityDashboardBalanceDescription>Available Balance</MobilityDashboardBalanceDescription>
        <BalanceToDisplayTransferToDescription>Current Balance</BalanceToDisplayTransferToDescription>
        <DefaultPaymentAmountTransferFromDescription>Current Balance</DefaultPaymentAmountTransferFromDescription>
        <CifInternal>HQ_Test_1428315</CifInternal>
        <MaskedCifInternal>HQ_Test_1428315</MaskedCifInternal>
        <IsPartialDetails>false</IsPartialDetails>
        <AccountLabel/>
        <Aba>4793490</Aba>
        <statusShortName>Visible</statusShortName>
        <OverviewAccountNumber/>
        <AccountNumberInternalUnmasked>5293467</AccountNumberInternalUnmasked>
        <AccountNumberExternalUnmasked>5293467</AccountNumberExternalUnmasked>
        <CIFInternalUnmasked>HQ_Test_1428315</CIFInternalUnmasked>
      </AccountListResponseRecord>
      <AccountListResponseRecord>
        <UserID>1</UserID>
        <HostAccountID>5001</HostAccountID>
        <AccountNumberInternal>XXXXXX9589</AccountNumberInternal>
        <ProductTypeName>Deposit</ProductTypeName>
        <ProductName>Regular Savings</ProductName>
        <AccountDesc>Savings</AccountDesc>
        <LinkType>A</LinkType>
        <DisplayOrder>1</DisplayOrder>
        <Balance1>104.26</Balance1>
        <BalanceDescription1>Available Balance</BalanceDescription1>
        <BalanceName1>AvailBal</BalanceName1>
        <BalanceType1>Currency</BalanceType1>
        <Balance2>104.26</Balance2>
        <BalanceDescription2>Current Balance</BalanceDescription2>
        <BalanceName2>CurBal</BalanceName2>
        <BalanceType2>Currency</BalanceType2>
        <ProductTypeVoiceFile>deposit.wav</ProductTypeVoiceFile>
        <ProductVoiceFile>regularSavings.wav</ProductVoiceFile>
        <HydraProductCode>S</HydraProductCode>
        <HydraProductTypeCode>D</HydraProductTypeCode>
        <DataAsOfDate>2017-05-25T10:43:18.847-05:00</DataAsOfDate>
        <APRorAPY>Y</APRorAPY>
        <Access>7</Access>
        <ProductID>3</ProductID>
        <ProductTypeID>1</ProductTypeID>
        <AllowPrincipal>false</AllowPrincipal>
        <AllowInterest>false</AllowInterest>
        <DisplayRunningBalance>false</DisplayRunningBalance>
        <CalculateRunningBalanceForyHistory>false</CalculateRunningBalanceForyHistory>
        <CalculateRunningBalanceForMemos>false</CalculateRunningBalanceForMemos>
        <RunningBalanceHadeNameToUse>CurBal</RunningBalanceHadeNameToUse>
        <HistoryCount>50</HistoryCount>
        <HistoryCountType>Items</HistoryCountType>
        <HasPendingMemos>false</HasPendingMemos>
        <IsExternalAccount>false</IsExternalAccount>
        <UserDisplayOrder>0</UserDisplayOrder>
        <BalanceToDisplay>104.26</BalanceToDisplay>
        <SortValue/>
        <Cif>HQ_Test_1428315</Cif>
        <MobilityDashboardBalance>104.26</MobilityDashboardBalance>
        <BalanceAdditionalDescription1>Available Balance</BalanceAdditionalDescription1>
        <BalanceAdditionalDescription2>Current Balance</BalanceAdditionalDescription2>
        <BalanceToDisplayTransferTo>104.26</BalanceToDisplayTransferTo>
        <DefaultPaymentAmountTransferFrom>104.26</DefaultPaymentAmountTransferFrom>
        <BalanceToDisplayDescription>Available Balance</BalanceToDisplayDescription>
        <MobilityDashboardBalanceDescription>Available Balance</MobilityDashboardBalanceDescription>
        <BalanceToDisplayTransferToDescription>Current Balance</BalanceToDisplayTransferToDescription>
        <DefaultPaymentAmountTransferFromDescription>Current Balance</DefaultPaymentAmountTransferFromDescription>
        <CifInternal>HQ_Test_1428315</CifInternal>
        <MaskedCifInternal>HQ_Test_1428315</MaskedCifInternal>
        <IsPartialDetails>false</IsPartialDetails>
        <AccountLabel/>
        <Aba>4793490</Aba>
        <statusShortName>Visible</statusShortName>
        <OverviewAccountNumber/>
        <AccountNumberInternalUnmasked>5019589</AccountNumberInternalUnmasked>
        <AccountNumberExternalUnmasked>5019589</AccountNumberExternalUnmasked>
        <CIFInternalUnmasked>HQ_Test_1428315</CIFInternalUnmasked>
      </AccountListResponseRecord>
      <Q2_AccountDataElements>
        <HostAccountID>5000</HostAccountID>
        <HADE_ID>1</HADE_ID>
        <HADEName>AvailBal</HADEName>
        <HADEDesc>Available Balance</HADEDesc>
        <HADEDataType>Currency</HADEDataType>
        <DataValue>389.49</DataValue>
        <DisplayOrder>-1</DisplayOrder>
        <AdditionalHadeDesc>Available Balance</AdditionalHadeDesc>
      </Q2_AccountDataElements>
      <Q2_AccountDataElements>
        <HostAccountID>5000</HostAccountID>
        <HADE_ID>4</HADE_ID>
        <HADEName>CurBal</HADEName>
        <HADEDesc>Current Balance</HADEDesc>
        <HADEDataType>Currency</HADEDataType>
        <DataValue>389.49</DataValue>
        <DisplayOrder>-1</DisplayOrder>
        <AdditionalHadeDesc>Current Balance</AdditionalHadeDesc>
      </Q2_AccountDataElements>
      <Q2_AccountDataElements>
        <HostAccountID>5001</HostAccountID>
        <HADE_ID>1</HADE_ID>
        <HADEName>AvailBal</HADEName>
        <HADEDesc>Available Balance</HADEDesc>
        <HADEDataType>Currency</HADEDataType>
        <DataValue>104.26</DataValue>
        <DisplayOrder>-1</DisplayOrder>
        <AdditionalHadeDesc>Available Balance</AdditionalHadeDesc>
      </Q2_AccountDataElements>
      <Q2_AccountDataElements>
        <HostAccountID>5001</HostAccountID>
        <HADE_ID>4</HADE_ID>
        <HADEName>CurBal</HADEName>
        <HADEDesc>Current Balance</HADEDesc>
        <HADEDataType>Currency</HADEDataType>
        <DataValue>104.26</DataValue>
        <DisplayOrder>-1</DisplayOrder>
        <AdditionalHadeDesc>Current Balance</AdditionalHadeDesc>
      </Q2_AccountDataElements>
    </AccountListResponse>
  </Data>
</Q2API>

class q2_sdk.hq.hq_api.q2_api.GetUserAccountList.ParamsObj(logger, online_user_name, desired_rights_bit_flag, desired_rights_is_explicit, desired_hydra_product_codes, hq_credentials=None)[source]

Bases: Q2ApiParamsObj

Parameters definition for GetUserAccountList

Parameters:

logger (TypeAliasType) – Reference to calling request’s logger (self.logger in your extension)
online_user_name (str) – Logon name of an online user
desired_rights_bit_flag (int) – 0: No rights, 7: View, Deposit, and Withdraw Rights
desired_rights_is_explicit (bool) – True: Only show accounts with rights that match desired_rights_bit_flag exactly. False: Show accounts with at least desired_rights_big_flag
desired_hydra_product_codes (str) – Pipe delimited list of 2 char values representing HydraProductTypeCode+HydraProductCode, with * allowed in HydraProductCode (D*|L*|C* for all deposit, loan and credit accounts)
hq_credentials (Optional[HqCredentials]) – Defaults to settings.HQ_CREDENTIALS

class q2_sdk.hq.hq_api.q2_api.GetUserAccountList.Q2_AccountDataElements(AdditionalHadeDesc, DataValue, DisplayOrder, HADEDataType, HADEDesc, HADEName, HADE_ID, HostAccountID)[source]

Bases: object

Q2_AccountDataElements(AdditionalHadeDesc: lxml.objectify.StringElement, DataValue: lxml.objectify.FloatElement, DisplayOrder: lxml.objectify.IntElement, HADEDataType: lxml.objectify.StringElement, HADEDesc: lxml.objectify.StringElement, HADEName: lxml.objectify.StringElement, HADE_ID: lxml.objectify.IntElement, HostAccountID: lxml.objectify.IntElement)

AdditionalHadeDesc: StringElement

DataValue: FloatElement

DisplayOrder: IntElement

HADEDataType: StringElement

HADEDesc: StringElement

HADEName: StringElement

HADE_ID: IntElement

HostAccountID: IntElement

class q2_sdk.hq.hq_api.q2_api.GetUserAccountList.AccountListResponseRecord(APRorAPY, Aba, Access, AccountDesc, AccountLabel, AccountNumberExternalUnmasked, AccountNumberInternal, AccountNumberInternalUnmasked, AllowInterest, AllowPrincipal, Balance1, Balance2, BalanceAdditionalDescription1, BalanceAdditionalDescription2, BalanceDescription1, BalanceDescription2, BalanceName1, BalanceName2, BalanceToDisplay, BalanceToDisplayDescription, BalanceToDisplayTransferTo, BalanceToDisplayTransferToDescription, BalanceType1, BalanceType2, CIFInternalUnmasked, CalculateRunningBalanceForMemos, CalculateRunningBalanceForyHistory, Cif, CifInternal, DataAsOfDate, DefaultPaymentAmountTransferFrom, DefaultPaymentAmountTransferFromDescription, DisplayOrder, DisplayRunningBalance, HasPendingMemos, HistoryCount, HistoryCountType, HostAccountID, HydraProductCode, HydraProductTypeCode, IsExternalAccount, IsPartialDetails, LinkType, MaskedCifInternal, MobilityDashboardBalance, MobilityDashboardBalanceDescription, NickName, OverviewAccountNumber, ProductID, ProductName, ProductTypeID, ProductTypeName, ProductTypeVoiceFile, ProductVoiceFile, RunningBalanceHadeNameToUse, SortValue, UserDisplayOrder, UserID, statusShortName)[source]

Bases: object

AccountListResponseRecord(APRorAPY: lxml.objectify.StringElement, Aba: lxml.objectify.IntElement, Access: lxml.objectify.IntElement, AccountDesc: lxml.objectify.StringElement, AccountLabel: lxml.objectify.StringElement, AccountNumberExternalUnmasked: lxml.objectify.IntElement, AccountNumberInternal: lxml.objectify.StringElement, AccountNumberInternalUnmasked: lxml.objectify.IntElement, AllowInterest: lxml.objectify.BoolElement, AllowPrincipal: lxml.objectify.BoolElement, Balance1: lxml.objectify.FloatElement, Balance2: lxml.objectify.FloatElement, BalanceAdditionalDescription1: lxml.objectify.StringElement, BalanceAdditionalDescription2: lxml.objectify.StringElement, BalanceDescription1: lxml.objectify.StringElement, BalanceDescription2: lxml.objectify.StringElement, BalanceName1: lxml.objectify.StringElement, BalanceName2: lxml.objectify.StringElement, BalanceToDisplay: lxml.objectify.FloatElement, BalanceToDisplayDescription: lxml.objectify.StringElement, BalanceToDisplayTransferTo: lxml.objectify.FloatElement, BalanceToDisplayTransferToDescription: lxml.objectify.StringElement, BalanceType1: lxml.objectify.StringElement, BalanceType2: lxml.objectify.StringElement, CIFInternalUnmasked: lxml.objectify.StringElement, CalculateRunningBalanceForMemos: lxml.objectify.BoolElement, CalculateRunningBalanceForyHistory: lxml.objectify.BoolElement, Cif: lxml.objectify.StringElement, CifInternal: lxml.objectify.StringElement, DataAsOfDate: lxml.objectify.StringElement, DefaultPaymentAmountTransferFrom: lxml.objectify.FloatElement, DefaultPaymentAmountTransferFromDescription: lxml.objectify.StringElement, DisplayOrder: lxml.objectify.IntElement, DisplayRunningBalance: lxml.objectify.BoolElement, HasPendingMemos: lxml.objectify.BoolElement, HistoryCount: lxml.objectify.IntElement, HistoryCountType: lxml.objectify.StringElement, HostAccountID: lxml.objectify.IntElement, HydraProductCode: lxml.objectify.StringElement, HydraProductTypeCode: lxml.objectify.StringElement, IsExternalAccount: lxml.objectify.BoolElement, IsPartialDetails: lxml.objectify.BoolElement, LinkType: lxml.objectify.StringElement, MaskedCifInternal: lxml.objectify.StringElement, MobilityDashboardBalance: lxml.objectify.FloatElement, MobilityDashboardBalanceDescription: lxml.objectify.StringElement, NickName: lxml.objectify.StringElement, OverviewAccountNumber: lxml.objectify.StringElement, ProductID: lxml.objectify.IntElement, ProductName: lxml.objectify.StringElement, ProductTypeID: lxml.objectify.IntElement, ProductTypeName: lxml.objectify.StringElement, ProductTypeVoiceFile: lxml.objectify.StringElement, ProductVoiceFile: lxml.objectify.StringElement, RunningBalanceHadeNameToUse: lxml.objectify.StringElement, SortValue: lxml.objectify.StringElement, UserDisplayOrder: lxml.objectify.IntElement, UserID: lxml.objectify.IntElement, statusShortName: lxml.objectify.StringElement)

APRorAPY: StringElement

Aba: IntElement

Access: IntElement

AccountDesc: StringElement

AccountLabel: StringElement

AccountNumberExternalUnmasked: IntElement

AccountNumberInternal: StringElement

AccountNumberInternalUnmasked: IntElement

AllowInterest: BoolElement

AllowPrincipal: BoolElement

Balance1: FloatElement

Balance2: FloatElement

BalanceAdditionalDescription1: StringElement

BalanceAdditionalDescription2: StringElement

BalanceDescription1: StringElement

BalanceDescription2: StringElement

BalanceName1: StringElement

BalanceName2: StringElement

BalanceToDisplay: FloatElement

BalanceToDisplayDescription: StringElement

BalanceToDisplayTransferTo: FloatElement

BalanceToDisplayTransferToDescription: StringElement

BalanceType1: StringElement

BalanceType2: StringElement

CIFInternalUnmasked: StringElement

CalculateRunningBalanceForMemos: BoolElement

CalculateRunningBalanceForyHistory: BoolElement

Cif: StringElement

CifInternal: StringElement

DataAsOfDate: StringElement

DefaultPaymentAmountTransferFrom: FloatElement

DefaultPaymentAmountTransferFromDescription: StringElement

DisplayOrder: IntElement

DisplayRunningBalance: BoolElement

HasPendingMemos: BoolElement

HistoryCount: IntElement

HistoryCountType: StringElement

HostAccountID: IntElement

HydraProductCode: StringElement

HydraProductTypeCode: StringElement

IsExternalAccount: BoolElement

IsPartialDetails: BoolElement

LinkType: StringElement

MaskedCifInternal: StringElement

MobilityDashboardBalance: FloatElement

MobilityDashboardBalanceDescription: StringElement

NickName: StringElement

OverviewAccountNumber: StringElement

ProductID: IntElement

ProductName: StringElement

ProductTypeID: IntElement

ProductTypeName: StringElement

ProductTypeVoiceFile: StringElement

ProductVoiceFile: StringElement

RunningBalanceHadeNameToUse: StringElement

SortValue: StringElement

UserDisplayOrder: IntElement

UserID: IntElement

statusShortName: StringElement

class q2_sdk.hq.hq_api.q2_api.GetUserAccountList.AccountListResponse(AccountListResponseRecord, Q2_AccountDataElements)[source]

Bases: object

AccountListResponse(AccountListResponseRecord: Union[q2_sdk.hq.hq_api.q2_api.GetUserAccountList.AccountListResponseRecord, List[q2_sdk.hq.hq_api.q2_api.GetUserAccountList.AccountListResponseRecord]], Q2_AccountDataElements: Union[q2_sdk.hq.hq_api.q2_api.GetUserAccountList.Q2_AccountDataElements, List[q2_sdk.hq.hq_api.q2_api.GetUserAccountList.Q2_AccountDataElements]])

AccountListResponseRecord: Union[AccountListResponseRecord, List[AccountListResponseRecord]]

Q2_AccountDataElements: Union[Q2_AccountDataElements, List[Q2_AccountDataElements]]

class q2_sdk.hq.hq_api.q2_api.GetUserAccountList.Data(AccountListResponse)[source]

Bases: object

Data(AccountListResponse: Union[q2_sdk.hq.hq_api.q2_api.GetUserAccountList.AccountListResponse, List[q2_sdk.hq.hq_api.q2_api.GetUserAccountList.AccountListResponse]])

AccountListResponse: Union[AccountListResponse, List[AccountListResponse]]

class q2_sdk.hq.hq_api.q2_api.GetUserAccountList.ResultNode[source]: Bases: object

class q2_sdk.hq.hq_api.q2_api.GetUserAccountList.HqResponse(raw_response)[source]

Bases: HqResponse

Parameters:: response – Body of HQ response

async q2_sdk.hq.hq_api.q2_api.GetUserAccountList.execute(params_obj, use_json=False, **kwargs)[source]

This is the default way to submit the request to HQ. In theory, both json and soap payloads are equally accepted by HQ, though several variables may affect that (HQ version, Q2SDK implementation bugs, etc). This should not affect anything about the way your code deals with the data. In fact, the only difference to consuming extensions is the logging. Basically, call this with default parameters unless you find a compelling reason not to.

Parameters:

params_obj (ParamsObj) – Object containing everything necessary to call this HQ endpoint
use_json – If True, will call HQ’s .ashx (json) endpoint instead of .asmx (soap)

Return type:

HqResponse

async q2_sdk.hq.hq_api.q2_api.GetUserAccountList.get_soap(params_obj, **kwargs)[source]

Deprecated. Please use execute instead

Return type:: HqResponse

async q2_sdk.hq.hq_api.q2_api.GetUserAccountList.get_json(params_obj, **kwargs)[source]

Deprecated. Please use execute instead

Return type:: HqResponse

q2_sdk.hq.hq_api.q2_api.GetUserAccountList.build_json(params_obj)[source]

q2_sdk.hq.hq_api.q2_api.GetUserAccountList.build_soap(params_obj)[source]