ServiceChargePlan

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

Bases: TableRow

ServiceChargePlanID: int

PlanName: str

Description: str

MonthsFree: int

BaseFee: float

MaxUsageFee: float

MaxTxnFee: float

SumUsageAndTxnFees: bool

NoMaxUsageFee: bool

NoMaxTxnFee: bool

class q2_sdk.hq.db.service_charge_plan.ServiceChargePlan(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 = 'PlanName'

NAME = 'ServiceChargePlan'

REPRESENTATION_ROW_CLASS: alias of ServiceChargePlanRow

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

async get(serialize_for_cli=False)[source]

Return type:: list[ServiceChargePlanRow]