GetAccountHistoryByIdWindowedWithUserId module

Get host account history by host account id

Sample response (may differ slightly in your environment)

<Q2API HqVersion="4.5.0.6095" HqAssemblyVersion="4.5.0.0" ServerDateTime="2024-03-06T13:01:42.0269637-06:00" AuditId="13632594">
        <Result>
            <ErrorCode ErrorType="Success">0</ErrorCode>
            <ErrorDescription />
            <HydraErrorReturnCode>0</HydraErrorReturnCode>
        </Result>
        <Data>
            <AllHostTransactions>
                <Transactions>
                    <AllTransactionType>0</AllTransactionType>
                    <TransactionID>26</TransactionID>
                    <HostAccountID>5000</HostAccountID>
                    <PostDate>2021-11-30T17:56:31-06:00</PostDate>
                    <TxnAmount>3891.2500</TxnAmount>
                    <Description>N9848 Q2 SOFTWAR DIR DEP 268904 10230 06/01/18</Description>
                    <HostTranNumber>33</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>
                    <HostPostDate>2021-11-30T17:56:31-06:00</HostPostDate>
                </Transactions>
                <Transactions>
                    <AllTransactionType>0</AllTransactionType>
                    <TransactionID>25</TransactionID>
                    <HostAccountID>5000</HostAccountID>
                    <PostDate>2022-01-25T17:56:31-06:00</PostDate>
                    <TxnAmount>113.9300</TxnAmount>
                    <Description>OREILLY AUTO 00023838 AUSTIN TX Date 06/01/18 2 7663590439 1 5533 Card 6357</Description>
                    <HostTranNumber>31</HostTranNumber>
                    <DorC>D</DorC>
                    <ShowImage>false</ShowImage>
                    <HostTranCodeID>2</HostTranCodeID>
                    <HostTranCode>W</HostTranCode>
                    <OfxTrnType>DEBIT</OfxTrnType>
                    <OfxCheckNumHandling>2</OfxCheckNumHandling>
                    <ShowTransactionItemDetail>false</ShowTransactionItemDetail>
                    <SignedTxnAmount>-113.9300</SignedTxnAmount>
                    <StatementDescription>OREILLY AUTO 00023838 AUSTIN TX Date 06/01/18 2 7663590439 1 5533 Card 6357</StatementDescription>
                    <HostPostDate>2022-01-25T17:56:31-06:00</HostPostDate>
                </Transactions>
                <MatchingTransactionCount>
                    <Count>26</Count>
                </MatchingTransactionCount>
            </AllHostTransactions>
        </Data>
    </Q2API>

class q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowedWithUserId.Operand

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.GetAccountHistoryByIdWindowedWithUserId.FilterItem(is_or_operator_not_and, operand, parens_before, parens_after, field_name=None, comparison_value=None, not_before_paren=False)

Bases: BaseParameter

serialize_as_xml()

serialize_as_json()

class q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowedWithUserId.OptionalFilter(filter_item=None)

Bases: BaseParameter

serialize_as_xml()

serialize_as_json()

class q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowedWithUserId.SortItem(ascending_sort, field_name=None)

Bases: BaseParameter

serialize_as_xml()

serialize_as_json()

class q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowedWithUserId.OptionalSort(sort_item=None)

Bases: BaseParameter

serialize_as_xml()

serialize_as_json()

class q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowedWithUserId.ParamsObj(logger, host_account_id, page_size, page_number, perform_history_lookup, perform_memo_lookup, perform_nsf_lookup, user_id, optional_filter=None, optional_sort=None, hq_credentials=None)

Bases: Q2ApiParamsObj

Parameters definition for GetAccountHistoryByIdWindowedWithUserId

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)

• user_id (int) – Q2_User.UserID

• 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.GetAccountHistoryByIdWindowedWithUserId.MatchingTransactionCount(Count)

Bases: object

MatchingTransactionCount(Count: lxml.objectify.IntElement)

Count: IntElement

class q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowedWithUserId.Transactions(AllTransactionType, Description, DorC, HostAccountID, HostPostDate, HostTranCode, HostTranCodeID, HostTranNumber, OfxCheckNumHandling, OfxTrnType, PostDate, ShowImage, ShowTransactionItemDetail, SignedTxnAmount, StatementDescription, TransactionID, TxnAmount)

Bases: object

Transactions(AllTransactionType: lxml.objectify.IntElement, Description: lxml.objectify.StringElement, DorC: lxml.objectify.StringElement, HostAccountID: lxml.objectify.IntElement, HostPostDate: lxml.objectify.StringElement, HostTranCode: lxml.objectify.StringElement, HostTranCodeID: lxml.objectify.IntElement, HostTranNumber: lxml.objectify.IntElement, 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

HostPostDate: StringElement

HostTranCode: StringElement

HostTranCodeID: IntElement

HostTranNumber: IntElement

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.GetAccountHistoryByIdWindowedWithUserId.AllHostTransactions(MatchingTransactionCount, Transactions)

Bases: object

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

MatchingTransactionCount: Union[MatchingTransactionCount, List[MatchingTransactionCount]]

Transactions: Union[Transactions, List[Transactions]]

class q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowedWithUserId.Data(AllHostTransactions)

Bases: object

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

AllHostTransactions: Union[AllHostTransactions, List[AllHostTransactions]]

class q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowedWithUserId.ResultNode

Bases: object

class q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowedWithUserId.HqResponse(raw_response)

Bases: HqResponse

Parameters:

response – Body of HQ response

async q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowedWithUserId.execute(params_obj, use_json=False, **kwargs)

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.GetAccountHistoryByIdWindowedWithUserId.get_soap(params_obj, **kwargs)

Deprecated. Please use execute instead

Return type:

HqResponse

async q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowedWithUserId.get_json(params_obj, **kwargs)

Deprecated. Please use execute instead

Return type:

HqResponse

q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowedWithUserId.build_json(params_obj)

q2_sdk.hq.hq_api.q2_api.GetAccountHistoryByIdWindowedWithUserId.build_soap(params_obj)