LinkedAccount

class q2_sdk.hq.db.linked_account.LinkedAccount(logger, hq_credentials=None, ret_table_obj=None)[source]

Bases: DbObject

Can link and unlink existing accounts in the Q2 product to customers and users. Combines the Q2_CustomerAccount and Q2_UserAccount tables

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)

add_arguments(parser)[source]

Hook for subclassed DbObjects to add custom arguments.

async get(user_id, serialize_for_cli=False)[source]
async get_customer_accounts(customer_id, serialize_for_cli=False)[source]
async add(customer_id, user_id, account_access, host_account_id, user_role_id=None)[source]
async add_by_primary_cif(customer_id, user_id, account_access, primary_cif, primary_only=True)[source]
async delete(user_id, host_account_id)[source]