AddRecurringFundsTransferByEndDate module

Add recurring funds transfer with an end date

class q2_sdk.hq.hq_api.wedge_online_banking.AddRecurringFundsTransferByEndDate.ParamsObj(logger, hq_credentials, source_account_id, target_account_id, transaction_amount, principal, interest, transfer_type, every_xweeks_or_months, frequency_bit_flags, start_date, end_date, optional_description=None, currency_code='USD', recurring_transaction_type=None)[source]

Bases: WedgeOnlineBankingParamsObj

Parameters definition for AddRecurringFundsTransferByEndDate

Parameters:

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

  • hq_credentials (HqCredentials) – HqCredentials instance with an hq_url and auth_token

  • source_account_id (int) – Q2_HostAccount.HostAccountID

  • target_account_id (int) – Q2_HostAccount.HostAccountID

  • transaction_amount (float) – ex. 2.43

  • principal (float) – ex. 2.43

  • interest (float)

  • transfer_type (int) – From the Q2_GeneratedTransactionTypes table (accessible through TransactionType DbObject)

  • 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)

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

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

  • currency_code (Optional[str]) – Q2_CurrencyCode.CurrencyCode. The currency to use for a transaction. This will almost always be “USD”

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

async q2_sdk.hq.hq_api.wedge_online_banking.AddRecurringFundsTransferByEndDate.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.wedge_online_banking.AddRecurringFundsTransferByEndDate.get_soap(params_obj, **kwargs)[source]

Deprecated. Please use execute instead

Return type:

HqResponse

async q2_sdk.hq.hq_api.wedge_online_banking.AddRecurringFundsTransferByEndDate.get_json(params_obj, **kwargs)[source]

Deprecated. Please use execute instead

Return type:

HqResponse

q2_sdk.hq.hq_api.wedge_online_banking.AddRecurringFundsTransferByEndDate.build_json(params_obj)[source]
q2_sdk.hq.hq_api.wedge_online_banking.AddRecurringFundsTransferByEndDate.build_soap(params_obj)[source]