RecurringTransaction

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

Bases: TableRow

RecurringTransactionID: int
TransactionID: int
CustomerID: int
UserID: int
TransactionType: str
EveryXWeeksOrMonths: int
NumberOfOccurrences: int
StartDate: str
EndDate: str
RecurringTransactionType: str
ExecutedOccurrences: int
LastOccurrence: str
class q2_sdk.hq.db.recurring_transaction.RecurringTransaction(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)

NAME = 'RecurringTransaction'
REPRESENTATION_ROW_CLASS

alias of RecurringTransactionRow

add_arguments(parser)[source]

Hook for subclassed DbObjects to add custom arguments.

async get(recurring_transaction_id, serialize_for_cli=False)[source]
Return type:

List[RecurringTransactionRow]