AddRecurringAchByCountByUserIdWithSecCode module

Add recurring ach by number of occurrences with SecCode

class q2_sdk.hq.hq_api.q2_api.AddRecurringAchByCountByUserIdWithSecCode.ParamsObj(logger, user_id, originating_account_id, transaction_amount, currency_code_id, subsidiary_id, recurring_transaction_type, every_xweeks_or_months, frequency_bit_flags, start_date, number_of_occurrences, transaction_type_short_name=None, description=None, ach_class_code=None, transaction_details_xml=None, hq_credentials=None)[source]

Bases: Q2ApiParamsObj

Parameters definition for AddRecurringAchByCountByUserIdWithSecCode

Parameters:

  • logger (TypeAliasType) – Reference to calling request’s logger (self.logger in your extension)

  • user_id (int) – Q2_User.UserID

  • originating_account_id (int) – Q2_HostAccount.HostAccountID

  • transaction_amount (float) – ex. 2.43

  • currency_code_id (int) – Q2_CurrentyCode.CurrencyCodeID

  • subsidiary_id (int) – Q2_Subsidiary.SubsidiaryID

  • recurring_transaction_type (str) – Value from q2_sdk.hq.models.transaction_info.RecurringTransactionType

  • every_xweeks_or_months (int) – Applies to Weeks or Months based on the value in recurring_transaction_type

  • frequency_bit_flags (int) – Calculated using q2_sdk.hq.api_helpers.get_frequency_bit_flags

  • start_date (str) – ex. 1980-10-23. Some HQ endpoints require a timestamp as well (1980-10-23T00:00:00)

  • number_of_occurrences (int)

  • transaction_type_short_name (Optional[str])

  • description (Optional[str]) – Free form text

  • ach_class_code (Optional[str])

  • transaction_details_xml (Optional[str])

  • hq_credentials (Optional[HqCredentials]) – Defaults to settings.HQ_CREDENTIALS

async q2_sdk.hq.hq_api.q2_api.AddRecurringAchByCountByUserIdWithSecCode.execute(params_obj, use_json=False, **kwargs)[source]

This is the default way to submit the request to HQ. In theory, both json and soap payloads are equally accepted by HQ, though several variables may affect that (HQ version, Q2SDK implementation bugs, etc). This should not affect anything about the way your code deals with the data. In fact, the only difference to consuming extensions is the logging. Basically, call this with default parameters unless you find a compelling reason not to.

Parameters:

  • params_obj (ParamsObj) – Object containing everything necessary to call this HQ endpoint

  • use_json – If True, will call HQ’s .ashx (json) endpoint instead of .asmx (soap)

Return type:

HqResponse

async q2_sdk.hq.hq_api.q2_api.AddRecurringAchByCountByUserIdWithSecCode.get_soap(params_obj, **kwargs)[source]

Deprecated. Please use execute instead

Return type:

HqResponse

async q2_sdk.hq.hq_api.q2_api.AddRecurringAchByCountByUserIdWithSecCode.get_json(params_obj, **kwargs)[source]

Deprecated. Please use execute instead

Return type:

HqResponse

q2_sdk.hq.hq_api.q2_api.AddRecurringAchByCountByUserIdWithSecCode.build_json(params_obj)[source]
q2_sdk.hq.hq_api.q2_api.AddRecurringAchByCountByUserIdWithSecCode.build_soap(params_obj)[source]