HostTranCode

class q2_sdk.hq.db.host_tran_code.HostTranCodeRow

Bases: RepresentationRowBase

HostTranCodeID: IntElement = 'HostTranCodeID'

HostTranCode: StringElement = 'HostTranCode'

TranCodeGroupID: IntElement = 'TranCodeGroupID'

DorC: StringElement = 'DorC'

TranCodeDesc: StringElement = 'TranCodeDesc'

ShowImage: BoolElement = 'ShowImage'

VoiceFileId: StringElement = 'VoiceFileId'

TransactionType: StringElement = 'TransactionType'

OfxTrnType: StringElement = 'OfxTrnType'

OfxCheckNumHandling: StringElement = 'OfxCheckNumHandling'

ShowTransactionItemDetail: StringElement = 'ShowTransactionItemDetail'

BaiTransactionTypeID: StringElement = 'BaiTransactionTypeID'

enum q2_sdk.hq.db.host_tran_code.DOrC(value)

Bases: Enum

Valid values are as follows:

Deposit = <DOrC.Deposit: 'D'>

Credit = <DOrC.Credit: 'C'>

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

GET_BY_NAME_KEY = 'HostTranCode'

REPRESENTATION_ROW_CLASS

alias of HostTranCodeRow

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async get(no_trunc=False, serialize_for_cli=False)

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)

async delete(host_tran_code_name)

Note: this only works in the dev environment