GetAccountHistoryByIdWindowed module

Get host account history by host account id

Sample response (may differ slightly in your environment)

<Q2API HqVersion="4.5.0.6023" HqAssemblyVersion="4.5.7849.32550" ServerDateTime="2021-08-17T18:42:47.9050136+00:00" AuditId="636017">
  <Result>
    <ErrorCode ErrorType="Success">0</ErrorCode>
    <ErrorDescription/>
    <HydraErrorReturnCode>0</HydraErrorReturnCode>
  </Result>
  <Data>
    <AllHostTransactions>
      <Transactions>
        <!--AllTransactionType indicates type of transaction (0 = Posted, 1 = Memo, 2 = Insufficient Funds -->
        <AllTransactionType>0</AllTransactionType>
        <TransactionID>59</TransactionID>
        <HostAccountID>5006</HostAccountID>
        <PostDate>2021-02-04T20:55:15+00:00</PostDate>
        <TxnAmount>3891.2500</TxnAmount>
        <Description>N9848 Q2 SOFTWAR DIR DEP 268904 10230 06/01/18</Description>
        <HostTranNumber>033</HostTranNumber>
        <DorC>C</DorC>
        <ShowImage>false</ShowImage>
        <HostTranCodeID>1</HostTranCodeID>
        <HostTranCode>D</HostTranCode>
        <OfxTrnType>CREDIT</OfxTrnType>
        <OfxCheckNumHandling>2</OfxCheckNumHandling>
        <ShowTransactionItemDetail>false</ShowTransactionItemDetail>
        <SignedTxnAmount>3891.2500</SignedTxnAmount>
        <StatementDescription>N9848 Q2 SOFTWAR DIR DEP 268904 10230 06/01/18</StatementDescription>
      </Transactions>
      <MatchingTransactionCount>
        <Count>1</Count>
      </MatchingTransactionCount>
    </AllHostTransactions>
  </Data>
</Q2API>

class q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowed.Operand[source]

Bases: object

NE = 'NE'

EQ = 'EQ'

GE = 'GE'

LE = 'LE'

GT = 'GT'

LT = 'LT'

BeginsWith = 'BeginsWith'

EndsWith = 'EndsWith'

Contains = 'Contains'

IsNull = 'IsNull'

NotNull = 'NotNull'

IN = 'IN'

class q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowed.FilterItem(is_or_operator_not_and, operand, parens_before, parens_after, field_name=None, comparison_value=None, not_before_paren=False)[source]

Bases: BaseParameter

serialize_as_xml()[source]

serialize_as_json()[source]

class q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowed.OptionalFilter(filter_item=None)[source]

Bases: BaseParameter

serialize_as_xml()[source]

serialize_as_json()[source]

class q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowed.SortItem(ascending_sort, field_name=None)[source]

Bases: BaseParameter

serialize_as_xml()[source]

serialize_as_json()[source]

class q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowed.OptionalSort(sort_item=None)[source]

Bases: BaseParameter

serialize_as_xml()[source]

serialize_as_json()[source]

class q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowed.ParamsObj(logger, host_account_id, page_size, page_number, perform_history_lookup, perform_memo_lookup, perform_nsf_lookup, optional_filter=None, optional_sort=None, hq_credentials=None)[source]

Bases: Q2ApiParamsObj

Parameters definition for GetAccountHistoryByIdWindowed

Parameters:

logger (TypeAliasType) – Reference to calling request’s logger (self.logger in your extension)
host_account_id (int) – Q2_HostAccount.HostAccountID
page_size (int) – The number of results to return per page
page_number (int) – The starting point of the page
perform_history_lookup (bool) – If True the account information will be retrieved
perform_memo_lookup (bool)
perform_nsf_lookup (bool)
optional_filter (Optional[OptionalFilter])
optional_sort (Optional[OptionalSort]) – OptionalSort object that contains a list of SortItem objects
hq_credentials (Optional[HqCredentials]) – Defaults to settings.HQ_CREDENTIALS

class q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowed.MatchingTransactionCount(Count)[source]

Bases: object

MatchingTransactionCount(Count: lxml.objectify.IntElement)

Count: IntElement

class q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowed.Transactions(AllTransactionType, Description, DorC, HostAccountID, HostTranCode, HostTranCodeID, HostTranNumber, OfxCheckNumHandling, OfxTrnType, PostDate, ShowImage, ShowTransactionItemDetail, SignedTxnAmount, StatementDescription, TransactionID, TxnAmount)[source]

Bases: object

Transactions(AllTransactionType: lxml.objectify.IntElement, Description: lxml.objectify.StringElement, DorC: lxml.objectify.StringElement, HostAccountID: lxml.objectify.IntElement, HostTranCode: lxml.objectify.StringElement, HostTranCodeID: lxml.objectify.IntElement, HostTranNumber: lxml.objectify.StringElement, OfxCheckNumHandling: lxml.objectify.IntElement, OfxTrnType: lxml.objectify.StringElement, PostDate: lxml.objectify.StringElement, ShowImage: lxml.objectify.BoolElement, ShowTransactionItemDetail: lxml.objectify.BoolElement, SignedTxnAmount: lxml.objectify.FloatElement, StatementDescription: lxml.objectify.StringElement, TransactionID: lxml.objectify.IntElement, TxnAmount: lxml.objectify.FloatElement)

AllTransactionType: IntElement

Description: StringElement

DorC: StringElement

HostAccountID: IntElement

HostTranCode: StringElement

HostTranCodeID: IntElement

HostTranNumber: StringElement

OfxCheckNumHandling: IntElement

OfxTrnType: StringElement

PostDate: StringElement

ShowImage: BoolElement

ShowTransactionItemDetail: BoolElement

SignedTxnAmount: FloatElement

StatementDescription: StringElement

TransactionID: IntElement

TxnAmount: FloatElement

class q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowed.AllHostTransactions(MatchingTransactionCount, Transactions)[source]

Bases: object

AllHostTransactions(MatchingTransactionCount: Union[q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowed.MatchingTransactionCount, List[q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowed.MatchingTransactionCount]], Transactions: Union[q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowed.Transactions, List[q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowed.Transactions]])

MatchingTransactionCount: Union[MatchingTransactionCount, List[MatchingTransactionCount]]

Transactions: Union[Transactions, List[Transactions]]

class q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowed.Data(AllHostTransactions)[source]

Bases: object

Data(AllHostTransactions: Union[q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowed.AllHostTransactions, List[q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowed.AllHostTransactions]])

AllHostTransactions: Union[AllHostTransactions, List[AllHostTransactions]]

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

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

Bases: HqResponse

Parameters:: response – Body of HQ response

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

Deprecated. Please use execute instead

Return type:: HqResponse

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

Deprecated. Please use execute instead

Return type:: HqResponse

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

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