ExternalTransaction

class q2_sdk.hq.db.external_transaction.ExternalTransactionRow

Bases: RepresentationRowBase

ExternalTransactionID: IntElement = 'ExternalTransactionID'

ExternalTransactionTypeID: IntElement = 'ExternalTransactionTypeID'

ExternalTransactionStatusID: IntElement = 'ExternalTransactionStatusID'

CreatedDate: StringElement = 'CreatedDate'

Description: StringElement = 'Description'

CustomerID: IntElement = 'CustomerID'

UserID: IntElement = 'UserID'

EffectiveDate: StringElement = 'EffectiveDate'

TransactionAmount: IntElement = 'TransactionAmount'

HostAccountID: IntElement = 'HostAccountID'

class q2_sdk.hq.db.external_transaction.ExternalTransaction(logger, hq_credentials=None, ret_table_obj=None)

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)

NAME = 'ExternalTransaction'

REPRESENTATION_ROW_CLASS

alias of ExternalTransactionRow

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async get(external_transaction_id, serialize_for_cli=False)

Return type:

List[ExternalTransactionRow]

async get_by_customer_id(customer_id, return_count=None, serialize_for_cli=False)

async get_by_user_id(user_id, return_count=None, serialize_for_cli=False)

async get_by_host_account_id(host_account_id, return_count=None, serialize_for_cli=False)