RecurringTransaction

class q2_sdk.hq.db.recurring_transaction.RecurringTransactionRow

Bases: RepresentationRowBase

RecurringTransactionID: IntElement = 'RecurringTransactionID'

TransactionID: IntElement = 'TransactionID'

CustomerID: IntElement = 'CustomerID'

UserID: IntElement = 'UserID'

TransactionType: StringElement = 'TransactionType'

EveryXWeeksOrMonths: IntElement = 'EveryXWeeksOrMonths'

NumberOfOccurrences: IntElement = 'NumberOfOccurrences'

StartDate: StringElement = 'StartDate'

EndDate: StringElement = 'EndDate'

RecurringTransactionType: StringElement = 'RecurringTransactionType'

ExecutedOccurrences: IntElement = 'ExecutedOccurrences'

LastOccurrence: StringElement = 'LastOccurrence'

class q2_sdk.hq.db.recurring_transaction.RecurringTransaction(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 = 'RecurringTransaction'

REPRESENTATION_ROW_CLASS

alias of RecurringTransactionRow

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async get(recurring_transaction_id, serialize_for_cli=False)

Return type:

List[RecurringTransactionRow]