HostTranCode

Used for mapping host specific data to generic Q2 shapes. Custom transaction codes are not supported with this table.

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

Bases: TableRow

HostTranCodeID: int

HostTranCode: str

TranCodeGroupID: int

DorC: str

TranCodeDesc: str

ShowImage: bool

VoiceFileId: str

TransactionType: str

OfxTrnType: str

OfxCheckNumHandling: str

ShowTransactionItemDetail: str

BaiTransactionTypeID: str

class q2_sdk.hq.db.host_tran_code.DOrC(*values)[source]

Bases: Enum

Deposit = 'D'

Credit = 'C'

class q2_sdk.hq.db.host_tran_code.HostTranCode(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 = 'HostTranCode'

GET_BY_NAME_KEY = 'HostTranCode'

REPRESENTATION_ROW_CLASS: alias of HostTranCodeRow

add_arguments(parser)[source]: Hook for subclassed DbObjects to add custom arguments.

async get(no_trunc=False, serialize_for_cli=False)[source]

Return type:: List[HostTranCodeRow]

async create(host_tran_code, tran_code_group_name, d_or_c, tran_code_desc, ofx_transaction_type_name, show_image=False, transaction_type=0, ofx_check_num_handling=0, show_transaction_item_detail=0)[source]

async delete(host_tran_code_name)[source]: Note: this only works in the dev environment