Template

class q2_sdk.hq.db.template.TemplateRow

Bases: RepresentationRowBase

TemplateID: IntElement = 'TemplateID'

TransactionTypeID: IntElement = 'TransactionTypeID'

TransactionType: StringElement = 'TransactionType'

TransactionTypeDescription: StringElement = 'TransactionTypeDescription'

BitFlags: IntElement = 'BitFlags'

Name: StringElement = 'Name'

Description: StringElement = 'Description'

CustomerID: IntElement = 'CustomerID'

CreateDate: StringElement = 'CreateDate'

LastEditDate: StringElement = 'LastEditDate'

IsSinglePayment: BoolElement = 'IsSinglePayment'

RecipientCount: IntElement = 'RecipientCount'

ACHClassCodeID: IntElement = 'ACHClassCodeID'

ACHClasCode: IntElement = 'ACHClasCode'

DefaultAccountID: IntElement = 'DefaultAccountID'

DefaultSubsidiaryID: IntElement = 'DefaultSubsidiaryID'

LastPaymentProcessedDate: StringElement = 'LastPaymentProcessedDate'

LastPaymentProcessedAmount: StringElement = 'LastPaymentProcessedAmount'

CompanyEntryDescription: StringElement = 'CompanyEntryDescription'

class q2_sdk.hq.db.template.TemplateRecipientRow

Bases: RepresentationRowBase

TemplateID: IntElement = 'TemplateID'

RecipientID: IntElement = 'RecipientID'

class q2_sdk.hq.db.template.Template(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)

GET_BY_NAME_KEY = 'Name'

NAME = 'Template'

REPRESENTATION_ROW_CLASS

alias of TemplateRow

async get(user_id)

Return type:

List[TemplateRow]

async get_template_recipients(template_id)

Return type:

List[TemplateRecipientRow]