Recipient

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

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)[source]

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)[source]

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)[source]

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(element, row_class=None, rename_fields=None)[source]

Bases: TableRow

RecipientID: int

DisplayName: str

WireName: str

CustomerID: int

EmailAddress: str

AlwaysSendEmail: bool

IsInternational: bool

ACHClassCodeID: int

AchName: str

IdentificationNumber: str

IsIndividual: bool

AccountID: int

AccountNumber: str

ABA: str

AccountType: str

AccountDescription: str

RecipientFIName: str

BIC: str

BranchBIC: str

RecipientFIAddress1: str

RecipientFIAddress2: str

RecipientFIAddress3: str

RecipientFICity: str

RecipientFIState: str

RecipientFIPostalCode: str

RecipientFICountry: str

IntermediaryABA: str

IBAN: str

ReceivingFiShortName: str

ReceivingFiAba: str

Address1: str

Address2: str

Address3: str

City: str

State: str

PostalCode: str

Country: str

q2_sdk.hq.db.recipient.from_row_to_dict(row, dataclass_type)[source]: 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)[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 = 'DisplayName'

NAME = 'Recipient'

REPRESENTATION_ROW_CLASS: alias of RecipientRow

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

async get_by_customer(customer_id, serialize_for_cli=False)[source]

Return type:: List[RecipientRow]

async get_by_recipient(recipient_id, serialize_for_cli=False)[source]

Return type:: List[RecipientRow]

async get_recipients(customer_id=None, logon_name='', recipient_id=None, serialize_for_cli=False)[source]