Transactions

class q2_sdk.hq.db.transactions.TransactionsRow(element, row_class=None, rename_fields=None)[source]

Bases: TableRow

TransactionID: int
CustomerID: int
UserID: int
CreateDate: str
TransactionType: str
TransactionAmount: float
OriginatingAccountID: int
class q2_sdk.hq.db.transactions.AchDetailRow(element, row_class=None, rename_fields=None)[source]

Bases: TableRow

TransactionID: int
CompanyName: str
BatchDiscretionaryData: str
CompanyIdentification: str
CompanyEntryDescription: str
CompanyDescriptiveDate: str
EffectiveEntryDate: str
ABA: str
AccountNumber: str
Amount: float
IdentificationNumber: str
Name: str
DetailDiscretionaryData: str
Addenda: str
EmailAddress: str
AchClassCode: str
RecipientDisplayName: str
ParentID: int
SettlementID: int
HasChildren: bool
AccountType: str
AccountNickName: str
AbaMasked: str
AccountNumberMasked: str
UserRoleID: int
SubsidiaryID: int
AccountTypeDescription: str
IsSameDayAch: bool
RecipientID: int
CustomerID: int
class q2_sdk.hq.db.transactions.Transactions(logger, hq_credentials=None, ret_table_obj=None)[source]

Bases: DbObject

Programmatic access to the Q2 database. Not as flexible as a true ORM, but takes the guesswork out of database schemas and ensures safety in the transactions.

Parameters:
  • logger – Reference to calling request’s logger (self.logger in your extension)

  • hq_credentials (Optional[HqCredentials]) – HQ Connectivity Information (Defaults to settings file)

  • ret_table_obj (Optional[bool]) – Flag to return list of LXML elements if False or TableRow objects from DB calls if True (Defaults to settings file)

REPRESENTATION_ROW_CLASS

alias of TransactionsRow

async get_suspect()[source]
Return type:

list[TransactionsRow]

async get_ach_details(transaction_ids, with_recipient_id=False)[source]

Takes a list of transaction ids and queries the database for additional ach details :param: transaction_ids: A list of generated transaction ids that are ach transaction types :param: with_recipient_id: When set to true, the results include RecipientID

Return type:

list[AchDetailRow]