Template

class q2_sdk.hq.db.template.TemplateRow(element, row_class=None, rename_fields=None)[source]

Bases: TableRow

TemplateID: int

TransactionTypeID: int

TransactionType: str

TransactionTypeDescription: str

BitFlags: int

Name: str

Description: str

CustomerID: int

CreateDate: str

LastEditDate: str

IsSinglePayment: bool

RecipientCount: int

ACHClassCodeID: int

ACHClassCode: str

DefaultAccountID: int

DefaultSubsidiaryID: int

LastPaymentProcessedDate: str

LastPaymentProcessedAmount: str

CompanyEntryDescription: str

class q2_sdk.hq.db.template.TemplateRecipientRow(element, row_class=None, rename_fields=None)[source]

Bases: TableRow

TemplateID: int

RecipientID: int

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

GET_BY_NAME_KEY = 'Name'

NAME = 'Template'

REPRESENTATION_ROW_CLASS: alias of TemplateRow

async get(user_id)[source]

Return type:: list[TemplateRow]

async get_template_recipients(template_id)[source]

Return type:: list[TemplateRecipientRow]

async get_by_subsidiary_ids(subsidiary_ids)[source]

Get templates for the specified subsidiary IDs.

Parameters:: subsidiary_ids (list[int]) – list of Q2_Subsidiary.SubsidiaryID to query
Return type:: list[TemplateRow]