Recipient

class q2_sdk.hq.db.recipient.RecipientTemplate(RecipientID, DisplayName, CustomerID, DefaultAccountID, EmailAddress, AlwaysSendEmail, IsInternational, ACHClassCodeID, AchName, WireName, IdentificationNumber)

Bases: object

RecipientTemplate(RecipientID: str, DisplayName: str, CustomerID: str, DefaultAccountID: str, EmailAddress: str, AlwaysSendEmail: str, IsInternational: str, ACHClassCodeID: str, AchName: str, WireName: str, IdentificationNumber: str)

RecipientID: str

DisplayName: str

CustomerID: str

DefaultAccountID: str

EmailAddress: str

AlwaysSendEmail: str

IsInternational: str

ACHClassCodeID: str

AchName: str

WireName: str

IdentificationNumber: str

class q2_sdk.hq.db.recipient.AccountTemplate(AccountID, RecipientID, AccountNumber, AccountTypeID, ABA)

Bases: object

AccountTemplate(AccountID: str, RecipientID: str, AccountNumber: str, AccountTypeID: str, ABA: str)

AccountID: str

RecipientID: str

AccountNumber: str

AccountTypeID: str

ABA: str

class q2_sdk.hq.db.recipient.RecipientFITemplate(RecipientFIDetailID, AccountID, Name, BIC, BranchBIC, Address1, Address2, Address3, City, State, PostalCode, CountryID, IntermediaryABA, IsIntermedFI, IBAN, ReceivingFiShortName, ReceivingFiAba)

Bases: object

RecipientFITemplate(RecipientFIDetailID: str, AccountID: str, Name: str, BIC: str, BranchBIC: str, Address1: str, Address2: str, Address3: str, City: str, State: str, PostalCode: str, CountryID: str, IntermediaryABA: str, IsIntermedFI: str, IBAN: str, ReceivingFiShortName: str, ReceivingFiAba: str)

RecipientFIDetailID: str

AccountID: str

Name: str

BIC: str

BranchBIC: str

Address1: str

Address2: str

Address3: str

City: str

State: str

PostalCode: str

CountryID: str

IntermediaryABA: str

IsIntermedFI: str

IBAN: str

ReceivingFiShortName: str

ReceivingFiAba: str

class q2_sdk.hq.db.recipient.AddressTemplate(RecipientAddressID, RecipientID, Address1, Address2, City, State, PostalCode, CountryID, Address3)

Bases: object

AddressTemplate(RecipientAddressID: str, RecipientID: str, Address1: str, Address2: str, City: str, State: str, PostalCode: str, CountryID: str, Address3: str)

RecipientAddressID: str

RecipientID: str

Address1: str

Address2: str

City: str

State: str

PostalCode: str

CountryID: str

Address3: str

class q2_sdk.hq.db.recipient.RecipientRow

Bases: RepresentationRowBase

RecipientID: IntElement = 'RecipientID'

DisplayName: StringElement = 'DisplayName'

WireName: StringElement = 'WireName'

CustomerID: IntElement = 'CustomerID'

EmailAddress: StringElement = 'EmailAddress'

AlwaysSendEmail: BoolElement = 'AlwaysSendEmail'

IsInternational: BoolElement = 'IsInternational'

ACHClassCodeID: IntElement = 'ACHClassCodeID'

AchName: StringElement = 'AchName'

IdentificationNumber: StringElement = 'IdentificationNumber'

IsIndividual: BoolElement = 'IsIndividual'

AccountID: IntElement = 'AccountID'

AccountNumber: StringElement = 'AccountNumber'

ABA: StringElement = 'ABA'

AccountType: StringElement = 'AccountType'

AccountDescription: StringElement = 'AccountDescription'

RecipientFIName: StringElement = 'RecipientFIName'

BIC: StringElement = 'BIC'

BranchBIC: StringElement = 'BranchBIC'

RecipientFIAddress1: StringElement = 'RecipientFIAddress1'

RecipientFIAddress2: StringElement = 'RecipientFIAddress2'

RecipientFIAddress3: StringElement = 'RecipientFIAddress3'

RecipientFICity: StringElement = 'RecipientFICity'

RecipientFIState: StringElement = 'RecipientFIState'

RecipientFIPostalCode: StringElement = 'RecipientFIPostalCode'

RecipientFICountry: StringElement = 'RecipientFICountry'

IntermediaryABA: StringElement = 'IntermediaryABA'

IBAN: StringElement = 'IBAN'

ReceivingFiShortName: StringElement = 'ReceivingFiShortName'

ReceivingFiAba: StringElement = 'ReceivingFiAba'

Address1: StringElement = 'Address1'

Address2: StringElement = 'Address2'

Address3: StringElement = 'Address3'

City: StringElement = 'City'

State: StringElement = 'State'

PostalCode: StringElement = 'PostalCode'

Country: StringElement = 'Country'

q2_sdk.hq.db.recipient.from_row_to_dict(row, dataclass_type)

Converts a given XML row returned from get_recipients to a dictionary

class q2_sdk.hq.db.recipient.Recipient(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 = 'DisplayName'

NAME = 'Recipient'

REPRESENTATION_ROW_CLASS

alias of RecipientRow

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async get_by_customer(customer_id, serialize_for_cli=False)

Return type:

List[RecipientRow]

async get_by_recipient(recipient_id, serialize_for_cli=False)

Return type:

List[RecipientRow]

async get_recipients(customer_id=None, logon_name='', recipient_id=None, serialize_for_cli=False)