GetAccounts module

Sample response (may differ slightly in your environment)

<Q2API HqVersion="4.5.0.6078" HqAssemblyVersion="4.5.0.0" ServerDateTime="2022-08-31T13:18:59.3275312+00:00" AuditId="2080963">
  <Result>
    <ErrorCode ErrorType="Success">0</ErrorCode>
    <ErrorDescription/>
    <HydraErrorReturnCode>0</HydraErrorReturnCode>
  </Result>
  <Data>
    <AccountListResponse>
      <AccountListResponseRecord>
        <UserID>2</UserID>
        <HostAccountID>5007</HostAccountID>
        <AccountNumberInternal>S01</AccountNumberInternal>
        <ProductTypeName>Q2 Savings</ProductTypeName>
        <ProductName>Q2 BUSINESS SAVINGS</ProductName>
        <AccountDesc/>
        <LinkType>C</LinkType>
        <DisplayOrder>0</DisplayOrder>
        <Balance1>152841.28</Balance1>
        <BalanceDescription1>Available Balance</BalanceDescription1>
        <BalanceName1>AvailBal</BalanceName1>
        <BalanceType1>Currency</BalanceType1>
        <Balance2/>
        <BalanceDescription2>Current Balance</BalanceDescription2>
        <BalanceName2>CurBal</BalanceName2>
        <BalanceType2>Currency</BalanceType2>
        <ProductTypeVoiceFile>savings.wav</ProductTypeVoiceFile>
        <ProductVoiceFile>sav.wav</ProductVoiceFile>
        <HydraProductCode>S</HydraProductCode>
        <HydraProductTypeCode>D</HydraProductTypeCode>
        <DataAsOfDate>2022-01-28T18:08:58+00:00</DataAsOfDate>
        <APRorAPY>R</APRorAPY>
        <Access>7</Access>
        <ProductID>20</ProductID>
        <ProductTypeID>6</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>5</UserDisplayOrder>
        <BalanceToDisplay>152841.28</BalanceToDisplay>
        <SortValue/>
        <Cif>07212010</Cif>
        <BalanceAdditionalDescription1/>
        <BalanceAdditionalDescription2/>
        <BalanceToDisplayTransferTo/>
        <DefaultPaymentAmountTransferFrom/>
        <BalanceToDisplayDescription>Available Balance</BalanceToDisplayDescription>
        <BalanceToDisplayTransferToDescription/>
        <DefaultPaymentAmountTransferFromDescription/>
        <CifInternal>07212010</CifInternal>
        <MaskedCifInternal>07212010</MaskedCifInternal>
        <CifExternal>07212010</CifExternal>
        <MaskedCifExternal>07212010</MaskedCifExternal>
        <IsPartialDetails>false</IsPartialDetails>
        <Aba/>
        <OverviewAccountNumber/>
        <canDisputeTransactions>false</canDisputeTransactions>
        <allowClose>false</allowClose>
        <IsPriority>false</IsPriority>
        <Balance3/>
        <BalanceDescription3/>
        <BalanceName3/>
        <BalanceType3/>
      </AccountListResponseRecord>
      <Q2_AccountDataElements>
        <HostAccountID>5007</HostAccountID>
        <HADE_ID>1</HADE_ID>
        <HADEName>AvailBal</HADEName>
        <HADEDesc>Available Balance</HADEDesc>
        <HADEDataType>Currency</HADEDataType>
        <DataValue>152841.28</DataValue>
        <DisplayOrder>7</DisplayOrder>
        <IsEditable>false</IsEditable>
      </Q2_AccountDataElements>
      <Q2_AccountDataElements>
        <HostAccountID>5007</HostAccountID>
        <HADE_ID>8</HADE_ID>
        <HADEName>IntRate</HADEName>
        <HADEDesc>Interest Rate</HADEDesc>
        <HADEDataType>Rate</HADEDataType>
        <DataValue>.10</DataValue>
        <DisplayOrder>14</DisplayOrder>
        <IsEditable>false</IsEditable>
      </Q2_AccountDataElements>
    </AccountListResponse>
  </Data>
</Q2API>

class q2_sdk.hq.hq_api.wedge_online_banking.GetAccounts.ParamsObj(logger, hq_credentials)[source]

Bases: WedgeOnlineBankingParamsObj

Parameters definition for GetAccounts

Parameters:

logger (TypeAliasType) – Reference to calling request’s logger (self.logger in your extension)
hq_credentials (HqCredentials) – HqCredentials instance with an hq_url and auth_token

class q2_sdk.hq.hq_api.wedge_online_banking.GetAccounts.Q2_AccountDataElements(DataValue, DisplayOrder, HADEDataType, HADEDesc, HADEName, HADE_ID, HostAccountID, IsEditable)[source]

Bases: object

Q2_AccountDataElements(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, IsEditable: lxml.objectify.BoolElement)

DataValue: FloatElement

DisplayOrder: IntElement

HADEDataType: StringElement

HADEDesc: StringElement

HADEName: StringElement

HADE_ID: IntElement

HostAccountID: IntElement

IsEditable: BoolElement

class q2_sdk.hq.hq_api.wedge_online_banking.GetAccounts.AccountListResponseRecord(APRorAPY, Aba, Access, AccountDesc, AccountNumberInternal, AllowInterest, AllowPrincipal, Balance1, Balance2, Balance3, BalanceAdditionalDescription1, BalanceAdditionalDescription2, BalanceDescription1, BalanceDescription2, BalanceDescription3, BalanceName1, BalanceName2, BalanceName3, BalanceToDisplay, BalanceToDisplayDescription, BalanceToDisplayTransferTo, BalanceToDisplayTransferToDescription, BalanceType1, BalanceType2, BalanceType3, CalculateRunningBalanceForMemos, CalculateRunningBalanceForyHistory, Cif, CifExternal, CifInternal, DataAsOfDate, DefaultPaymentAmountTransferFrom, DefaultPaymentAmountTransferFromDescription, DisplayOrder, DisplayRunningBalance, HasPendingMemos, HistoryCount, HistoryCountType, HostAccountID, HydraProductCode, HydraProductTypeCode, IsExternalAccount, IsPartialDetails, IsPriority, LinkType, MaskedCifExternal, MaskedCifInternal, OverviewAccountNumber, ProductID, ProductName, ProductTypeID, ProductTypeName, ProductTypeVoiceFile, ProductVoiceFile, RunningBalanceHadeNameToUse, SortValue, UserDisplayOrder, UserID, allowClose, canDisputeTransactions)[source]

Bases: object

AccountListResponseRecord(APRorAPY: lxml.objectify.StringElement, Aba: lxml.objectify.StringElement, Access: lxml.objectify.IntElement, AccountDesc: lxml.objectify.StringElement, AccountNumberInternal: lxml.objectify.StringElement, AllowInterest: lxml.objectify.BoolElement, AllowPrincipal: lxml.objectify.BoolElement, Balance1: lxml.objectify.FloatElement, Balance2: lxml.objectify.StringElement, Balance3: lxml.objectify.StringElement, BalanceAdditionalDescription1: lxml.objectify.StringElement, BalanceAdditionalDescription2: lxml.objectify.StringElement, BalanceDescription1: lxml.objectify.StringElement, BalanceDescription2: lxml.objectify.StringElement, BalanceDescription3: lxml.objectify.StringElement, BalanceName1: lxml.objectify.StringElement, BalanceName2: lxml.objectify.StringElement, BalanceName3: lxml.objectify.StringElement, BalanceToDisplay: lxml.objectify.FloatElement, BalanceToDisplayDescription: lxml.objectify.StringElement, BalanceToDisplayTransferTo: lxml.objectify.StringElement, BalanceToDisplayTransferToDescription: lxml.objectify.StringElement, BalanceType1: lxml.objectify.StringElement, BalanceType2: lxml.objectify.StringElement, BalanceType3: lxml.objectify.StringElement, CalculateRunningBalanceForMemos: lxml.objectify.BoolElement, CalculateRunningBalanceForyHistory: lxml.objectify.BoolElement, Cif: lxml.objectify.StringElement, CifExternal: lxml.objectify.StringElement, CifInternal: lxml.objectify.StringElement, DataAsOfDate: lxml.objectify.StringElement, DefaultPaymentAmountTransferFrom: lxml.objectify.StringElement, 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, IsPriority: lxml.objectify.BoolElement, LinkType: lxml.objectify.StringElement, MaskedCifExternal: lxml.objectify.StringElement, MaskedCifInternal: 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, allowClose: lxml.objectify.BoolElement, canDisputeTransactions: lxml.objectify.BoolElement)

APRorAPY: StringElement

Aba: StringElement

Access: IntElement

AccountDesc: StringElement

AccountNumberInternal: StringElement

AllowInterest: BoolElement

AllowPrincipal: BoolElement

Balance1: FloatElement

Balance2: StringElement

Balance3: StringElement

BalanceAdditionalDescription1: StringElement

BalanceAdditionalDescription2: StringElement

BalanceDescription1: StringElement

BalanceDescription2: StringElement

BalanceDescription3: StringElement

BalanceName1: StringElement

BalanceName2: StringElement

BalanceName3: StringElement

BalanceToDisplay: FloatElement

BalanceToDisplayDescription: StringElement

BalanceToDisplayTransferTo: StringElement

BalanceToDisplayTransferToDescription: StringElement

BalanceType1: StringElement

BalanceType2: StringElement

BalanceType3: StringElement

CalculateRunningBalanceForMemos: BoolElement

CalculateRunningBalanceForyHistory: BoolElement

Cif: StringElement

CifExternal: StringElement

CifInternal: StringElement

DataAsOfDate: StringElement

DefaultPaymentAmountTransferFrom: StringElement

DefaultPaymentAmountTransferFromDescription: StringElement

DisplayOrder: IntElement

DisplayRunningBalance: BoolElement

HasPendingMemos: BoolElement

HistoryCount: IntElement

HistoryCountType: StringElement

HostAccountID: IntElement

HydraProductCode: StringElement

HydraProductTypeCode: StringElement

IsExternalAccount: BoolElement

IsPartialDetails: BoolElement

IsPriority: BoolElement

LinkType: StringElement

MaskedCifExternal: StringElement

MaskedCifInternal: StringElement

OverviewAccountNumber: StringElement

ProductID: IntElement

ProductName: StringElement

ProductTypeID: IntElement

ProductTypeName: StringElement

ProductTypeVoiceFile: StringElement

ProductVoiceFile: StringElement

RunningBalanceHadeNameToUse: StringElement

SortValue: StringElement

UserDisplayOrder: IntElement

UserID: IntElement

allowClose: BoolElement

canDisputeTransactions: BoolElement

class q2_sdk.hq.hq_api.wedge_online_banking.GetAccounts.AccountListResponse(AccountListResponseRecord, Q2_AccountDataElements)[source]

Bases: object

AccountListResponse(AccountListResponseRecord: Union[q2_sdk.hq.hq_api.wedge_online_banking.GetAccounts.AccountListResponseRecord, List[q2_sdk.hq.hq_api.wedge_online_banking.GetAccounts.AccountListResponseRecord]], Q2_AccountDataElements: Union[q2_sdk.hq.hq_api.wedge_online_banking.GetAccounts.Q2_AccountDataElements, List[q2_sdk.hq.hq_api.wedge_online_banking.GetAccounts.Q2_AccountDataElements]])

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

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

class q2_sdk.hq.hq_api.wedge_online_banking.GetAccounts.Data(AccountListResponse)[source]

Bases: object

Data(AccountListResponse: Union[q2_sdk.hq.hq_api.wedge_online_banking.GetAccounts.AccountListResponse, List[q2_sdk.hq.hq_api.wedge_online_banking.GetAccounts.AccountListResponse]])

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

class q2_sdk.hq.hq_api.wedge_online_banking.GetAccounts.ResultNode[source]: Bases: object

class q2_sdk.hq.hq_api.wedge_online_banking.GetAccounts.HqResponse(raw_response)[source]

Bases: HqResponse

Parameters:: response – Body of HQ response

async q2_sdk.hq.hq_api.wedge_online_banking.GetAccounts.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.wedge_online_banking.GetAccounts.get_soap(params_obj, **kwargs)[source]

Deprecated. Please use execute instead

Return type:: HqResponse

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

Deprecated. Please use execute instead

Return type:: HqResponse

q2_sdk.hq.hq_api.wedge_online_banking.GetAccounts.build_json(params_obj)[source]

q2_sdk.hq.hq_api.wedge_online_banking.GetAccounts.build_soap(params_obj)[source]