ProcessGeneratedTransactions models

DataSet models for ProcessGeneratedTransactions.

These typed dataclass models represent the tables and columns within the DataSet parameters for the ProcessGeneratedTransactions HQ operation.

IMPORTANT: Update operations require a GET first to populate the original_record field. HQ uses the unchanged row for optimistic concurrency checking.

Usage:

from q2_sdk.hq.hq_api.backoffice import ProcessGeneratedTransactions

q2_generated_transaction_view = ProcessGeneratedTransactions.Q2GeneratedTransactionView(
    transaction_id=1,
    customer_id=1,
    customer_name="...",
    user_id=1,
    create_date="...",
    ui_source_id=1,
    ui_source="...",
    transaction_status_id=1,
    transaction_status="...",
    transaction_status_description="...",
    transaction_type_id=1,
    transaction_type="...",
    transaction_type_description="...",
    diagnostic=True,
    group_id=1,
    group_desc="...",
    oob_auth_required=True,
    oob_auth_provided=True,
    is_reversed=True,
)

q2_change_of_address_transaction_accounts = ProcessGeneratedTransactions.Q2ChangeOfAddressTransactionAccounts(
    transaction_id=1,
    host_account_id=1,
    account_number_internal="...",
    product_id=1,
    product_name="...",
    hydra_product_code="...",
    host_product_code="...",
    product_type_id=1,
    hydra_product_type_code="...",
)

q2_change_of_address_transactions = ProcessGeneratedTransactions.Q2ChangeOfAddressTransactions(
    transaction_id=1,
)

q2_check_re_order_transactions = ProcessGeneratedTransactions.Q2CheckReOrderTransactions(
)

q2_funds_transfer_transactions = ProcessGeneratedTransactions.Q2FundsTransferTransactions(
    transaction_id=1,
    account_number_internal="...",
    product_id=1,
    product_name="...",
    hydra_product_code="...",
    host_product_code="...",
    product_type_id=1,
    product_type_name="...",
    hydra_product_type_code="...",
    is_external_account=True,
)

q2_stop_payment_transactions = ProcessGeneratedTransactions.Q2StopPaymentTransactions(
    transaction_id=1,
)

q2_bill_payment_transactions = ProcessGeneratedTransactions.Q2BillPaymentTransactions(
    transaction_id=1,
    payee_name="...",
    account_number_or_memo="...",
    pay_as_name="...",
    pay_as_address1="...",
    pay_as_city="...",
    pay_as_state="...",
    pay_as_postal_code="...",
    is_international=True,
    name="...",
    payee_type="...",
)

q2_ach_ppd_ccd_transactions = ProcessGeneratedTransactions.Q2AchPpdCcdTransactions(
    transaction_id=1,
    company_name="...",
    company_identification="...",
    ach_class_code_id=1,
    ach_class_code="...",
    company_entry_description="...",
    effective_entry_date="...",
    transaction_type_id=1,
    is_same_day_ach=True,
)

q2_ach_iat_transactions = ProcessGeneratedTransactions.Q2AchIatTransactions(
    ach_iat_batch_id=1,
    transaction_id=1,
    transaction_type_id=1,
    originator_identification="...",
    company_entry_description="...",
    effective_entry_date="...",
    recipient_count=1,
    service_class_code="...",
    foreign_exchange_indicator="...",
    destination_currency_code="...",
)

q2_wire_domestic_transactions = ProcessGeneratedTransactions.Q2WireDomesticTransactions(
    transaction_id=1,
    wire_transfer_id=1,
    to_account="...",
    to_account_type="...",
    recip_country_name="...",
    rec_fi_country_name="...",
)

q2_external_transfer_transactions = ProcessGeneratedTransactions.Q2ExternalTransferTransactions(
    transaction_id=1,
    is_same_day_ach=True,
    account_number_internal="...",
    product_id=1,
    product_name="...",
    hydra_product_code="...",
    to_host_product_code="...",
    product_type_id=1,
    product_type_name="...",
    hydra_product_type_code="...",
    is_from_account_external=True,
    from_host_product_code="...",
    is_to_account_external=True,
)

q2_wire_international_transactions = ProcessGeneratedTransactions.Q2WireInternationalTransactions(
    transaction_id=1,
    wire_transfer_id=1,
    to_account="...",
    to_account_type="...",
    rate_applied_to_usd_equivalent=True,
)

q2_send_check_transactions = ProcessGeneratedTransactions.Q2SendCheckTransactions(
    transaction_id=1,
    send_to_acct_owner=True,
    is_cashier_or_certified_check=True,
)

q2_ach_pass_thru_transactions = ProcessGeneratedTransactions.Q2AchPassThruTransactions(
    ach_pass_thru_id=1,
    transaction_id=1,
    transaction_type_id=1,
    ach_file="...",
)

q2_rtp_get_transactions = ProcessGeneratedTransactions.Q2RTPGetTransactions(
    child_bitflag=1,
    create_date="...",
    currency_code="...",
    customer_id=1,
    diagnostic=True,
    host_product_code="...",
    is_reversed=True,
    oob_auth_provided=True,
    oob_auth_required=True,
    transaction_status_id=1,
    transaction_type_id=1,
    ui_source_id=1,
    user_id=1,
    outgoing=True,
    local_entity_name="...",
    local_entity_tax_id="...",
    remote_entity_name="...",
    remote_fi_account_number="...",
    remote_fi_routing_number="...",
    rtp_request_type_short_name="...",
    created_at="...",
    rtp_vendor_short_name="...",
)

class q2_sdk.hq.hq_api.backoffice.ProcessGeneratedTransactions_models.Q2GeneratedTransactionView(transaction_id=0, customer_id=0, customer_name='', user_id=0, user_name=None, create_date='', ui_source_id=0, ui_source='', transaction_status_id=0, transaction_status='', transaction_status_description='', transaction_type_id=0, transaction_type='', transaction_type_description='', process_date=None, processed_date=None, diagnostic=False, prefunding_status=None, prefunding_reason=None, host_account_id=None, account_number_internal=None, account_number_external=None, product_id=None, product_name=None, product_type_id=None, product_type_name=None, transaction_amount=None, currency_code=None, authorized_by_id=None, authorized_by=None, authorized_date=None, modified_by_id=None, modified_by=None, modified_date=None, recurring_transaction_id=None, description=None, template_id=None, host_result=None, hydra_product_type_code=None, host_product_type_code=None, hydra_product_code=None, host_product_code=None, processing_type_id=None, processing_type=None, processing_type_description=None, target_description=None, parent_id=None, settlement_id=None, has_children=None, is_distributed_funding_child=None, is_settlement_funding_child=None, skip_balance_check=None, cif_internal=None, account_nick_name=None, effective_date=None, bill_payee_id=None, payee_display_name=None, payee_name=None, audit_score_id=None, tran_score_status=None, tran_score_weight=None, login_score_id=None, login_score_status=None, login_score_weight=None, group_id=0, group_desc='', to_host_account_id=None, to_account_number_internal=None, to_account_number_external=None, to_product_name=None, to_product_type_name=None, has_case_notes=None, score_audit_id=None, authorizing_user_credentials=None, gam_rights_bit_flag=None, user_role_id=None, recipient_count=None, subsidiary_id=None, gt_batch_id=None, recipient_name=None, intermediary_bank_name=None, beneficiary_bank_name=None, message_to_beneficiary=None, template_name=None, template_description=None, oob_auth_required=False, oob_auth_provided=False, recipient_account_number=None, recipient_account_type=None, principal=None, interest=None, usd_equivalent_amount=None, recipient_identification_number=None, is_same_day_ach=None, company_entry_description=None, purpose_of_wire=None, ach_class_code=None, has_wage_garnishment_payments=None, replaces_transaction_id=None, replaced_by_transaction_id=None, is_reversed=False, reversed_gtid=None, is_reversible=None, to_product_id=None, to_hydra_product_type_code=None, to_hydra_product_code=None, to_host_product_type_code=None, to_host_product_code=None, is_production=None, zone_id=None, zone=None, is_ach_iat=None, file_name=None, gt_flavor_id=None, gt_flavor_short_name=None, recurring_master=None, real_time_payment_id=None, rtp_thread_id=None, rtp_outgoing=None, rtp_request_type_short_name=None, rtp_vendor_short_name=None, expiry_date=None, vendor_status=None, vendor_status_date_time=None, service_call_unique_identifier=None, service_call_conversation_identifier=None, subsidiary_name=None, is_large_batch_workflow=None, is_aggregate=None, cif_external=None, host_branch=None, tax_version_id=None, file_delivery_status_id=None, file_delivery_status=None, file_delivery_date_time=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_GeneratedTransactionView table.

transaction_id: int = 0

customer_id: int = 0

customer_name: str = ''

user_id: int = 0

user_name: str | None = None

create_date: str = ''

ui_source_id: int = 0

ui_source: str = ''

transaction_status_id: int = 0

transaction_status: str = ''

transaction_status_description: str = ''

transaction_type_id: int = 0

transaction_type: str = ''

transaction_type_description: str = ''

process_date: str | None = None

processed_date: str | None = None

diagnostic: bool = False

prefunding_status: str | None = None

prefunding_reason: str | None = None

host_account_id: int | None = None

account_number_internal: str | None = None

account_number_external: str | None = None

product_id: int | None = None

product_name: str | None = None

product_type_id: int | None = None

product_type_name: str | None = None

transaction_amount: float | None = None

currency_code: str | None = None

authorized_by_id: int | None = None

authorized_by: str | None = None

authorized_date: str | None = None

modified_by_id: int | None = None

modified_by: str | None = None

modified_date: str | None = None

recurring_transaction_id: int | None = None

description: str | None = None

template_id: int | None = None

host_result: str | None = None

hydra_product_type_code: str | None = None

host_product_type_code: str | None = None

hydra_product_code: str | None = None

host_product_code: str | None = None

processing_type_id: int | None = None

processing_type: str | None = None

processing_type_description: str | None = None

target_description: str | None = None

parent_id: int | None = None

settlement_id: int | None = None

has_children: bool | None = None

is_distributed_funding_child: bool | None = None

is_settlement_funding_child: bool | None = None

skip_balance_check: bool | None = None

cif_internal: str | None = None

account_nick_name: str | None = None

effective_date: str | None = None

bill_payee_id: int | None = None

payee_display_name: str | None = None

payee_name: str | None = None

audit_score_id: int | None = None

tran_score_status: int | None = None

tran_score_weight: int | None = None

login_score_id: int | None = None

login_score_status: int | None = None

login_score_weight: int | None = None

group_id: int = 0

group_desc: str = ''

to_host_account_id: int | None = None

to_account_number_internal: str | None = None

to_account_number_external: str | None = None

to_product_name: str | None = None

to_product_type_name: str | None = None

has_case_notes: bool | None = None

score_audit_id: int | None = None

authorizing_user_credentials: str | None = None

gam_rights_bit_flag: int | None = None

user_role_id: int | None = None

recipient_count: int | None = None

subsidiary_id: int | None = None

gt_batch_id: int | None = None

recipient_name: str | None = None

intermediary_bank_name: str | None = None

beneficiary_bank_name: str | None = None

message_to_beneficiary: str | None = None

template_name: str | None = None

template_description: str | None = None

oob_auth_required: bool = False

oob_auth_provided: bool = False

recipient_account_number: str | None = None

recipient_account_type: str | None = None

principal: float | None = None

interest: float | None = None

usd_equivalent_amount: float | None = None

recipient_identification_number: str | None = None

is_same_day_ach: bool | None = None

company_entry_description: str | None = None

purpose_of_wire: str | None = None

ach_class_code: str | None = None

has_wage_garnishment_payments: bool | None = None

replaces_transaction_id: int | None = None

replaced_by_transaction_id: int | None = None

is_reversed: bool = False

reversed_gtid: int | None = None

is_reversible: bool | None = None

to_product_id: int | None = None

to_hydra_product_type_code: str | None = None

to_hydra_product_code: str | None = None

to_host_product_type_code: str | None = None

to_host_product_code: str | None = None

is_production: bool | None = None

zone_id: int | None = None

zone: str | None = None

is_ach_iat: bool | None = None

file_name: str | None = None

gt_flavor_id: int | None = None

gt_flavor_short_name: str | None = None

recurring_master: bool | None = None

real_time_payment_id: int | None = None

rtp_thread_id: int | None = None

rtp_outgoing: bool | None = None

rtp_request_type_short_name: str | None = None

rtp_vendor_short_name: str | None = None

expiry_date: str | None = None

vendor_status: str | None = None

vendor_status_date_time: str | None = None

service_call_unique_identifier: str | None = None

service_call_conversation_identifier: str | None = None

subsidiary_name: str | None = None

is_large_batch_workflow: bool | None = None

is_aggregate: bool | None = None

cif_external: str | None = None

host_branch: str | None = None

tax_version_id: str | None = None

file_delivery_status_id: int | None = None

file_delivery_status: str | None = None

file_delivery_date_time: str | None = None

original_record: Q2GeneratedTransactionView | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2GeneratedTransactionView

class q2_sdk.hq.hq_api.backoffice.ProcessGeneratedTransactions_models.Q2ChangeOfAddressTransactionAccounts(transaction_id=0, host_account_id=0, account_number_internal='', account_number_external=None, product_id=0, product_name='', hydra_product_code='', host_product_code='', product_type_id=0, hydra_product_type_code='', host_product_type_code=None, cif_internal=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_ChangeOfAddressTransactionAccounts table.

transaction_id: int = 0

host_account_id: int = 0

account_number_internal: str = ''

account_number_external: str | None = None

product_id: int = 0

product_name: str = ''

hydra_product_code: str = ''

host_product_code: str = ''

product_type_id: int = 0

hydra_product_type_code: str = ''

host_product_type_code: str | None = None

cif_internal: str | None = None

original_record: Q2ChangeOfAddressTransactionAccounts | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2ChangeOfAddressTransactionAccounts

class q2_sdk.hq.hq_api.backoffice.ProcessGeneratedTransactions_models.Q2ChangeOfAddressTransactions(transaction_id=0, street_address1=None, street_address2=None, city=None, state=None, postal_code=None, old_street_address1=None, old_street_address2=None, old_city=None, old_state=None, old_postal_code=None, old_country_id=None, old_address_type=None, home_phone_number=None, work_phone_number=None, cell_phone_number=None, email_address=None, country_id=None, country_name=None, old_country_name=None, province=None, old_province=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_ChangeOfAddressTransactions table.

transaction_id: int = 0

street_address1: str | None = None

street_address2: str | None = None

city: str | None = None

state: str | None = None

postal_code: str | None = None

old_street_address1: str | None = None

old_street_address2: str | None = None

old_city: str | None = None

old_state: str | None = None

old_postal_code: str | None = None

old_country_id: int | None = None

old_address_type: str | None = None

home_phone_number: str | None = None

work_phone_number: str | None = None

cell_phone_number: str | None = None

email_address: str | None = None

country_id: int | None = None

country_name: str | None = None

old_country_name: str | None = None

province: str | None = None

old_province: str | None = None

original_record: Q2ChangeOfAddressTransactions | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2ChangeOfAddressTransactions

class q2_sdk.hq.hq_api.backoffice.ProcessGeneratedTransactions_models.Q2CheckReOrderTransactions(transaction_id=None, starting_check_number=None, number_of_boxes=None, check_line1=None, check_line2=None, check_line3=None, check_line4=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_CheckReOrderTransactions table.

transaction_id: int | None = None

starting_check_number: str | None = None

number_of_boxes: int | None = None

check_line1: str | None = None

check_line2: str | None = None

check_line3: str | None = None

check_line4: str | None = None

original_record: Q2CheckReOrderTransactions | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2CheckReOrderTransactions

class q2_sdk.hq.hq_api.backoffice.ProcessGeneratedTransactions_models.Q2FundsTransferTransactions(transaction_id=0, principal=None, interest=None, transfer_type=None, to_account_id=None, account_number_internal='', account_number_external=None, product_id=0, product_name='', hydra_product_code='', host_product_code='', product_type_id=0, product_type_name='', hydra_product_type_code='', host_product_type_code=None, cif_internal=None, gt_data=None, flavor_bit_flag=None, cif_external=None, host_branch=None, is_external_account=False, aba=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_FundsTransferTransactions table.

transaction_id: int = 0

principal: float | None = None

interest: float | None = None

transfer_type: int | None = None

to_account_id: int | None = None

account_number_internal: str = ''

account_number_external: str | None = None

product_id: int = 0

product_name: str = ''

hydra_product_code: str = ''

host_product_code: str = ''

product_type_id: int = 0

product_type_name: str = ''

hydra_product_type_code: str = ''

host_product_type_code: str | None = None

cif_internal: str | None = None

gt_data: str | None = None

flavor_bit_flag: int | None = None

cif_external: str | None = None

host_branch: str | None = None

is_external_account: bool = False

aba: str | None = None

original_record: Q2FundsTransferTransactions | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2FundsTransferTransactions

class q2_sdk.hq.hq_api.backoffice.ProcessGeneratedTransactions_models.Q2StopPaymentTransactions(transaction_id=0, check_number=None, end_check_number=None, check_date=None, payee_name=None, end_date=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_StopPaymentTransactions table.

transaction_id: int = 0

check_number: str | None = None

end_check_number: str | None = None

check_date: str | None = None

payee_name: str | None = None

end_date: str | None = None

original_record: Q2StopPaymentTransactions | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2StopPaymentTransactions

class q2_sdk.hq.hq_api.backoffice.ProcessGeneratedTransactions_models.Q2BillPaymentTransactions(transaction_id=0, payee_name='', street_address1=None, street_address2=None, city=None, state=None, postal_code=None, email_address=None, account_number_or_memo='', pay_as_name='', pay_as_address1='', pay_as_address2=None, pay_as_city='', pay_as_state='', pay_as_postal_code='', is_international=False, province=None, city_or_area_code=None, local_number=None, extension=None, name='', payee_type='', original_record=None)[source]

Bases: object

Represents a row in the Q2_BillPaymentTransactions table.

transaction_id: int = 0

payee_name: str = ''

street_address1: str | None = None

street_address2: str | None = None

city: str | None = None

state: str | None = None

postal_code: str | None = None

email_address: str | None = None

account_number_or_memo: str = ''

pay_as_name: str = ''

pay_as_address1: str = ''

pay_as_address2: str | None = None

pay_as_city: str = ''

pay_as_state: str = ''

pay_as_postal_code: str = ''

is_international: bool = False

province: str | None = None

city_or_area_code: str | None = None

local_number: str | None = None

extension: str | None = None

name: str = ''

payee_type: str = ''

original_record: Q2BillPaymentTransactions | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2BillPaymentTransactions

class q2_sdk.hq.hq_api.backoffice.ProcessGeneratedTransactions_models.Q2AchPpdCcdTransactions(transaction_id=0, company_name='', discretionary_data=None, company_identification='', ach_class_code_id=0, ach_class_code='', company_entry_description='', company_descriptive_date=None, effective_entry_date='', originating_tran_code_id=None, tran_code=None, tran_code_description=None, account_type_id=None, account_type=None, account_type_description=None, tran_code_type=None, addenda=None, transaction_type_id=0, is_same_day_ach=False, original_record=None)[source]

Bases: object

Represents a row in the Q2_AchPpdCcdTransactions table.

transaction_id: int = 0

company_name: str = ''

discretionary_data: str | None = None

company_identification: str = ''

ach_class_code_id: int = 0

ach_class_code: str = ''

company_entry_description: str = ''

company_descriptive_date: str | None = None

effective_entry_date: str = ''

originating_tran_code_id: int | None = None

tran_code: str | None = None

tran_code_description: str | None = None

account_type_id: int | None = None

account_type: str | None = None

account_type_description: str | None = None

tran_code_type: str | None = None

addenda: str | None = None

transaction_type_id: int = 0

is_same_day_ach: bool = False

original_record: Q2AchPpdCcdTransactions | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2AchPpdCcdTransactions

class q2_sdk.hq.hq_api.backoffice.ProcessGeneratedTransactions_models.Q2AchIatTransactions(ach_iat_batch_id=0, transaction_id=0, transaction_type_id=0, originator_identification='', company_entry_description='', effective_entry_date='', recipient_count=0, service_class_code='', foreign_exchange_indicator='', destination_currency_code='', original_record=None)[source]

Bases: object

Represents a row in the Q2_AchIatTransactions table.

ach_iat_batch_id: int = 0

transaction_id: int = 0

transaction_type_id: int = 0

originator_identification: str = ''

company_entry_description: str = ''

effective_entry_date: str = ''

recipient_count: int = 0

service_class_code: str = ''

foreign_exchange_indicator: str = ''

destination_currency_code: str = ''

original_record: Q2AchIatTransactions | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2AchIatTransactions

class q2_sdk.hq.hq_api.backoffice.ProcessGeneratedTransactions_models.Q2WireDomesticTransactions(transaction_id=0, wire_transfer_id=0, to_account='', to_account_type='', recip_name=None, recip_address1=None, recip_address2=None, recip_city=None, recip_state=None, recip_address3=None, recip_postal_code=None, recip_country_id=None, recip_country_name='', email_address=None, payer_name=None, payer_address1=None, payer_address2=None, payer_city=None, payer_state=None, payer_province=None, payer_postal=None, payer_country_id=None, payer_country_name=None, rec_fi_aba=None, rec_fi_name=None, rec_fi_address1=None, rec_fi_address2=None, rec_fi_city=None, rec_fi_state=None, rec_fi_postal_code=None, rec_fi_country_id=None, rec_fi_country_name='', intermed_aba=None, intermed_name=None, intermed_address1=None, intermed_address2=None, intermed_city=None, intermed_state=None, intermed_postal_code=None, intermed_country_id=None, intermed_country_name=None, orig_to_benf_info=None, receiving_fi_short_name=None, receiving_fi_aba=None, fi_to_fi_info=None, ref_for_beneficiary=None, message_input_reference=None, imad=None, purpose_of_wire=None, swift_code_or_bic=None, account_num_between_banks=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_WireDomesticTransactions table.

transaction_id: int = 0

wire_transfer_id: int = 0

to_account: str = ''

to_account_type: str = ''

recip_name: str | None = None

recip_address1: str | None = None

recip_address2: str | None = None

recip_city: str | None = None

recip_state: str | None = None

recip_address3: str | None = None

recip_postal_code: str | None = None

recip_country_id: int | None = None

recip_country_name: str = ''

email_address: str | None = None

payer_name: str | None = None

payer_address1: str | None = None

payer_address2: str | None = None

payer_city: str | None = None

payer_state: str | None = None

payer_province: str | None = None

payer_postal: str | None = None

payer_country_id: int | None = None

payer_country_name: str | None = None

rec_fi_aba: str | None = None

rec_fi_name: str | None = None

rec_fi_address1: str | None = None

rec_fi_address2: str | None = None

rec_fi_city: str | None = None

rec_fi_state: str | None = None

rec_fi_postal_code: str | None = None

rec_fi_country_id: int | None = None

rec_fi_country_name: str = ''

intermed_aba: str | None = None

intermed_name: str | None = None

intermed_address1: str | None = None

intermed_address2: str | None = None

intermed_city: str | None = None

intermed_state: str | None = None

intermed_postal_code: str | None = None

intermed_country_id: int | None = None

intermed_country_name: str | None = None

orig_to_benf_info: str | None = None

receiving_fi_short_name: str | None = None

receiving_fi_aba: str | None = None

fi_to_fi_info: str | None = None

ref_for_beneficiary: str | None = None

message_input_reference: str | None = None

imad: str | None = None

purpose_of_wire: str | None = None

swift_code_or_bic: str | None = None

account_num_between_banks: str | None = None

original_record: Q2WireDomesticTransactions | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2WireDomesticTransactions

class q2_sdk.hq.hq_api.backoffice.ProcessGeneratedTransactions_models.Q2ExternalTransferTransactions(transaction_id=0, principal=None, interest=None, transfer_type=None, to_account_id=None, is_same_day_ach=False, account_number_internal='', account_number_external=None, product_id=0, product_name='', hydra_product_code='', to_host_product_code='', product_type_id=0, product_type_name='', hydra_product_type_code='', to_host_product_type_code=None, host_user=None, host_pwd=None, is_from_account_external=False, from_aba=None, from_cif_internal=None, from_cif_external=None, from_host_product_code='', from_host_product_type_code=None, from_host_branch=None, is_to_account_external=False, to_aba=None, to_cif_internal=None, to_cif_external=None, to_host_branch=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_ExternalTransferTransactions table.

transaction_id: int = 0

principal: float | None = None

interest: float | None = None

transfer_type: int | None = None

to_account_id: int | None = None

is_same_day_ach: bool = False

account_number_internal: str = ''

account_number_external: str | None = None

product_id: int = 0

product_name: str = ''

hydra_product_code: str = ''

to_host_product_code: str = ''

product_type_id: int = 0

product_type_name: str = ''

hydra_product_type_code: str = ''

to_host_product_type_code: str | None = None

host_user: str | None = None

host_pwd: str | None = None

is_from_account_external: bool = False

from_aba: str | None = None

from_cif_internal: str | None = None

from_cif_external: str | None = None

from_host_product_code: str = ''

from_host_product_type_code: str | None = None

from_host_branch: str | None = None

is_to_account_external: bool = False

to_aba: str | None = None

to_cif_internal: str | None = None

to_cif_external: str | None = None

to_host_branch: str | None = None

original_record: Q2ExternalTransferTransactions | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2ExternalTransferTransactions

class q2_sdk.hq.hq_api.backoffice.ProcessGeneratedTransactions_models.Q2WireInternationalTransactions(transaction_id=0, wire_transfer_id=0, to_account='', to_account_type='', recip_name=None, recip_address1=None, recip_address2=None, recip_address3=None, recip_email_address=None, payer_name=None, payer_address1=None, payer_address2=None, payer_city=None, payer_state=None, payer_province=None, payer_postal=None, payer_country_id=None, payer_country_name=None, orig_to_benf_info=None, rec_fi_swift_or_bic=None, rec_fi_name=None, rec_fi_address1=None, rec_fi_address2=None, rec_fi_address3=None, intermed_swift_or_bic=None, intermed_name=None, intermed_address1=None, intermed_address2=None, intermed_address3=None, currency_code_id=None, recip_fi_iban=None, intermed_fi_iban=None, recip_country_id=None, rec_fi_country_id=None, intermed_country_id=None, intermed_aba=None, recip_country_name=None, rec_fi_country_name=None, intermed_country_name=None, quote_id=None, booking_id=None, usd_equivalent_amount=None, exchange_rate=None, value_date=None, receiving_fi_short_name=None, receiving_fi_aba=None, fi_to_fi_info=None, ref_for_beneficiary=None, message_input_reference=None, imad=None, purpose_of_wire=None, rate_applied_to_usd_equivalent=False, user_booking_wire_rate_contract=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_WireInternationalTransactions table.

transaction_id: int = 0

wire_transfer_id: int = 0

to_account: str = ''

to_account_type: str = ''

recip_name: str | None = None

recip_address1: str | None = None

recip_address2: str | None = None

recip_address3: str | None = None

recip_email_address: str | None = None

payer_name: str | None = None

payer_address1: str | None = None

payer_address2: str | None = None

payer_city: str | None = None

payer_state: str | None = None

payer_province: str | None = None

payer_postal: str | None = None

payer_country_id: int | None = None

payer_country_name: str | None = None

orig_to_benf_info: str | None = None

rec_fi_swift_or_bic: str | None = None

rec_fi_name: str | None = None

rec_fi_address1: str | None = None

rec_fi_address2: str | None = None

rec_fi_address3: str | None = None

intermed_swift_or_bic: str | None = None

intermed_name: str | None = None

intermed_address1: str | None = None

intermed_address2: str | None = None

intermed_address3: str | None = None

currency_code_id: int | None = None

recip_fi_iban: str | None = None

intermed_fi_iban: str | None = None

recip_country_id: int | None = None

rec_fi_country_id: int | None = None

intermed_country_id: int | None = None

intermed_aba: str | None = None

recip_country_name: str | None = None

rec_fi_country_name: str | None = None

intermed_country_name: str | None = None

quote_id: str | None = None

booking_id: str | None = None

usd_equivalent_amount: float | None = None

exchange_rate: float | None = None

value_date: str | None = None

receiving_fi_short_name: str | None = None

receiving_fi_aba: str | None = None

fi_to_fi_info: str | None = None

ref_for_beneficiary: str | None = None

message_input_reference: str | None = None

imad: str | None = None

purpose_of_wire: str | None = None

rate_applied_to_usd_equivalent: bool = False

user_booking_wire_rate_contract: str | None = None

original_record: Q2WireInternationalTransactions | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2WireInternationalTransactions

class q2_sdk.hq.hq_api.backoffice.ProcessGeneratedTransactions_models.Q2SendCheckTransactions(transaction_id=0, send_to_acct_owner=False, recipient_name=None, recipient_address1=None, recipient_address2=None, recipient_city=None, recipient_state=None, recipient_postal_code=None, is_cashier_or_certified_check=False, payer_name=None, payer_address1=None, payer_address2=None, payer_city=None, payer_state=None, payer_postal_code=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_SendCheckTransactions table.

transaction_id: int = 0

send_to_acct_owner: bool = False

recipient_name: str | None = None

recipient_address1: str | None = None

recipient_address2: str | None = None

recipient_city: str | None = None

recipient_state: str | None = None

recipient_postal_code: str | None = None

is_cashier_or_certified_check: bool = False

payer_name: str | None = None

payer_address1: str | None = None

payer_address2: str | None = None

payer_city: str | None = None

payer_state: str | None = None

payer_postal_code: str | None = None

original_record: Q2SendCheckTransactions | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2SendCheckTransactions

class q2_sdk.hq.hq_api.backoffice.ProcessGeneratedTransactions_models.Q2AchPassThruTransactions(ach_pass_thru_id=0, transaction_id=0, debit_total=None, credit_total=None, debit_count=None, credit_count=None, addenda_count=None, transaction_type_id=0, batch_count=None, ach_file='', file_name=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_AchPassThruTransactions table.

ach_pass_thru_id: int = 0

transaction_id: int = 0

debit_total: float | None = None

credit_total: float | None = None

debit_count: int | None = None

credit_count: int | None = None

addenda_count: int | None = None

transaction_type_id: int = 0

batch_count: int | None = None

ach_file: str = ''

file_name: str | None = None

original_record: Q2AchPassThruTransactions | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2AchPassThruTransactions

class q2_sdk.hq.hq_api.backoffice.ProcessGeneratedTransactions_models.Q2RTPGetTransactions(authorized_date=None, authorized_user_id=None, auth_token_id=None, child_bitflag=0, create_date='', currency_code_id=None, currency_code='', customer_id=0, description=None, diagnostic=False, account_number_internal=None, account_number_external=None, cif_internal=None, cif_external=None, host_product_code='', host_product_type_code=None, branch_id=None, gt_credential_type_id=None, host_result=None, host_tracking_id=None, is_reversed=False, modified_date=None, oob_auth_provided=False, oob_auth_required=False, originating_account_id=None, parent_id=None, process_date=None, processed_date=None, recurring_master=None, recurring_transaction_id=None, replaced_by_transaction_id=None, replaces_transaction_id=None, settlement_id=None, subsidiary_id_=None, target_description=None, template_id=None, transaction_amount=None, transaction_id=-1, transaction_status_id=0, transaction_type_id=0, ui_source_id=0, user_id=0, user_role_id=None, real_time_payment_id=-1, outgoing=False, local_entity_name='', local_entity_identifier=None, local_entity_tax_id='', local_entity_address1=None, local_entity_address2=None, local_entity_address3=None, local_entity_city=None, local_entity_state=None, local_entity_postal_code=None, local_entity_country_id=None, local_entity_email_address=None, local_entity_phone_number=None, local_entity_phone_country_id=None, remote_entity_name='', remote_entity_identifier=None, remote_entity_address1=None, remote_entity_address2=None, remote_entity_address3=None, remote_entity_city=None, remote_entity_state=None, remote_entity_postal_code=None, remote_entity_country_id=None, remote_entity_email_address=None, remote_fi_account_number='', remote_fi_account_type=None, remote_fi_routing_number='', remote_fi_address1=None, remote_fi_address2=None, remote_fi_address3=None, remote_fi_city=None, remote_fi_state=None, remote_fi_postal_code=None, remote_fi_country_id=None, remote_fi_name=None, intermed_fi_name=None, intermed_fi_routing_number=None, intermed_fi_address1=None, intermed_fi_address2=None, intermed_fi_address3=None, intermed_fi_city=None, intermed_fi_state=None, intermed_fi_postal_code=None, intermed_fi_country_id=None, request_type_id=-1, rtp_request_type_short_name='', thread_id=-1, created_at='', vendor_id=-1, rtp_vendor_short_name='', end_date=None, every_x_weeks_or_months=None, executed_occurrences=None, first_child_is_same_day=None, frequency_bit_flags=None, last_occurrence=None, next_occurrence=None, number_of_occurrences=None, replaced_by_recurring_transaction_id=None, replaces_recurring_transaction_id=None, start_date=None, recurring_transaction_type=None, rtp_data_xml=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_RTPGetTransactions table.

authorized_date: str | None = None

authorized_user_id: int | None = None

auth_token_id: int | None = None

child_bitflag: int = 0

create_date: str = ''

currency_code_id: int | None = None

currency_code: str = ''

customer_id: int = 0

description: str | None = None

diagnostic: bool = False

account_number_internal: str | None = None

account_number_external: str | None = None

cif_internal: str | None = None

cif_external: str | None = None

host_product_code: str = ''

host_product_type_code: str | None = None

branch_id: int | None = None

gt_credential_type_id: int | None = None

host_result: str | None = None

host_tracking_id: str | None = None

is_reversed: bool = False

modified_date: str | None = None

oob_auth_provided: bool = False

oob_auth_required: bool = False

originating_account_id: int | None = None

parent_id: int | None = None

process_date: str | None = None

processed_date: str | None = None

recurring_master: bool | None = None

recurring_transaction_id: int | None = None

replaced_by_transaction_id: int | None = None

replaces_transaction_id: int | None = None

settlement_id: int | None = None

subsidiary_id_: int | None = None

target_description: str | None = None

template_id: int | None = None

transaction_amount: float | None = None

transaction_id: int = -1

transaction_status_id: int = 0

transaction_type_id: int = 0

ui_source_id: int = 0

user_id: int = 0

user_role_id: int | None = None

real_time_payment_id: int = -1

outgoing: bool = False

local_entity_name: str = ''

local_entity_identifier: str | None = None

local_entity_tax_id: str = ''

local_entity_address1: str | None = None

local_entity_address2: str | None = None

local_entity_address3: str | None = None

local_entity_city: str | None = None

local_entity_state: str | None = None

local_entity_postal_code: str | None = None

local_entity_country_id: int | None = None

local_entity_email_address: str | None = None

local_entity_phone_number: str | None = None

local_entity_phone_country_id: int | None = None

remote_entity_name: str = ''

remote_entity_identifier: str | None = None

remote_entity_address1: str | None = None

remote_entity_address2: str | None = None

remote_entity_address3: str | None = None

remote_entity_city: str | None = None

remote_entity_state: str | None = None

remote_entity_postal_code: str | None = None

remote_entity_country_id: int | None = None

remote_entity_email_address: str | None = None

remote_fi_account_number: str = ''

remote_fi_account_type: str | None = None

remote_fi_routing_number: str = ''

remote_fi_address1: str | None = None

remote_fi_address2: str | None = None

remote_fi_address3: str | None = None

remote_fi_city: str | None = None

remote_fi_state: str | None = None

remote_fi_postal_code: str | None = None

remote_fi_country_id: int | None = None

remote_fi_name: str | None = None

intermed_fi_name: str | None = None

intermed_fi_routing_number: str | None = None

intermed_fi_address1: str | None = None

intermed_fi_address2: str | None = None

intermed_fi_address3: str | None = None

intermed_fi_city: str | None = None

intermed_fi_state: str | None = None

intermed_fi_postal_code: str | None = None

intermed_fi_country_id: int | None = None

request_type_id: int = -1

rtp_request_type_short_name: str = ''

thread_id: int = -1

created_at: str = ''

vendor_id: int = -1

rtp_vendor_short_name: str = ''

end_date: str | None = None

every_x_weeks_or_months: int | None = None

executed_occurrences: int | None = None

first_child_is_same_day: bool | None = None

frequency_bit_flags: int | None = None

last_occurrence: str | None = None

next_occurrence: str | None = None

number_of_occurrences: int | None = None

replaced_by_recurring_transaction_id: int | None = None

replaces_recurring_transaction_id: int | None = None

start_date: str | None = None

recurring_transaction_type: int | None = None

rtp_data_xml: str | None = None

original_record: Q2RTPGetTransactions | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2RTPGetTransactions

q2_sdk.hq.hq_api.backoffice.ProcessGeneratedTransactions_models.build_generated_transactions_dataset(q2_generated_transaction_view=None)[source]

Build the generated_transactions DataSet parameter for ProcessGeneratedTransactions.

For update operations, each model instance should have its original_record set to the pre-modification state (from a prior GET call).