AddRecipientsCse models

DataSet models for AddRecipientsCse.

These typed dataclass models represent the tables and columns within the DataSet parameters for the AddRecipientsCse 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 AddRecipientsCse

q2_recipient_account = AddRecipientsCse.Q2RecipientAccount(
    recipient_id=1,
    account_number="...",
    account_type_id=1,
)

q2_recipient_address = AddRecipientsCse.Q2RecipientAddress(
    recipient_id=1,
)

q2_recipient_fi_detail = AddRecipientsCse.Q2RecipientFIDetail(
    account_id=1,
    is_intermed_fi=True,
)

q2_recipient = AddRecipientsCse.Q2Recipient(
    display_name="...",
    customer_id=1,
    always_send_email=True,
    is_international=True,
    ach_class_code_id=1,
)

q2_recipient_account_wage_garnishment = AddRecipientsCse.Q2RecipientAccountWageGarnishment(
    account_id=1,
    disbursement_unit_name="...",
    tax_type_short_name="...",
    entry_type_short_name="...",
)

q2_recipient_pending = AddRecipientsCse.Q2RecipientPending(
    recipient_id=1,
    change_status="...",
    customer_id_=1,
    created_at="...",
)

q2_user = AddRecipientsCse.Q2User(
    customer_id=1,
    create_date="...",
    auto_generated=True,
    use_customer_accounts=True,
    user_status_id=1,
)

q2_recipient_fi_additional_detail = AddRecipientsCse.Q2RecipientFiAdditionalDetail(
    recipient_fi_detail_id=1,
    is_iat_enabled=True,
    is_wire_enabled=True,
)

class q2_sdk.hq.hq_api.backoffice.AddRecipientsCse_models.Q2RecipientAccount(account_id=-1, recipient_id=0, account_number='', account_type_id=0, aba=None, wage_garnishment_tax_type_code_id=None, wage_garnishment_addenda=None, rtp_aba=None, allowed_rtp_payment_rails=None, pre_note_expiration=None, pending_pre_note_expiration=None, wire_fi_id=None, wire_type_id=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_RecipientAccount table.

account_id: int = -1

recipient_id: int = 0

account_number: str = ''

account_type_id: int = 0

aba: str | None = None

wage_garnishment_tax_type_code_id: int | None = None

wage_garnishment_addenda: str | None = None

rtp_aba: str | None = None

allowed_rtp_payment_rails: int | None = None

pre_note_expiration: str | None = None

pending_pre_note_expiration: str | None = None

wire_fi_id: str | None = None

wire_type_id: int | None = None

original_record: Q2RecipientAccount | 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:: Q2RecipientAccount

class q2_sdk.hq.hq_api.backoffice.AddRecipientsCse_models.Q2RecipientAddress(recipient_address_id=-1, recipient_id=0, address1=None, address2=None, city=None, state=None, postal_code=None, country_id=None, address3=None, province=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_RecipientAddress table.

recipient_address_id: int = -1

recipient_id: int = 0

address1: str | None = None

address2: str | None = None

city: str | None = None

state: str | None = None

postal_code: str | None = None

country_id: int | None = None

address3: str | None = None

province: str | None = None

original_record: Q2RecipientAddress | 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:: Q2RecipientAddress

class q2_sdk.hq.hq_api.backoffice.AddRecipientsCse_models.Q2RecipientFIDetail(recipient_fi_detail_id=-1, account_id=0, name=None, bic=None, branch_bic=None, address1=None, address2=None, address3=None, city=None, state=None, postal_code=None, country_id=None, intermediary_aba=None, is_intermed_fi=False, iban=None, receiving_fi_short_name=None, receiving_fi_aba=None, account_num_between_banks=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_RecipientFIDetail table.

recipient_fi_detail_id: int = -1

account_id: int = 0

name: str | None = None

bic: str | None = None

branch_bic: str | None = None

address1: str | None = None

address2: str | None = None

address3: str | None = None

city: str | None = None

state: str | None = None

postal_code: str | None = None

country_id: int | None = None

intermediary_aba: str | None = None

is_intermed_fi: bool = False

iban: str | None = None

receiving_fi_short_name: str | None = None

receiving_fi_aba: str | None = None

account_num_between_banks: str | None = None

original_record: Q2RecipientFIDetail | 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:: Q2RecipientFIDetail

class q2_sdk.hq.hq_api.backoffice.AddRecipientsCse_models.Q2Recipient(recipient_id=-1, display_name='', customer_id=0, default_account_id=None, email_address=None, always_send_email=False, is_international=False, ach_class_code_id=0, ach_name=None, wire_name=None, identification_number=None, is_individual=None, rtp_name=None, legal_entity_identifier=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_Recipient table.

recipient_id: int = -1

display_name: str = ''

customer_id: int = 0

default_account_id: int | None = None

email_address: str | None = None

always_send_email: bool = False

is_international: bool = False

ach_class_code_id: int = 0

ach_name: str | None = None

wire_name: str | None = None

identification_number: str | None = None

is_individual: bool | None = None

rtp_name: str | None = None

legal_entity_identifier: str | None = None

original_record: Q2Recipient | 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:: Q2Recipient

class q2_sdk.hq.hq_api.backoffice.AddRecipientsCse_models.Q2RecipientAccountWageGarnishment(wage_garnishment_id=-1, account_id=0, disbursement_unit_name='', tax_type_short_name='', entry_type_short_name='', case_identifier=None, garnished_ssn=None, medical_support_indicator=None, originator_reference_id=None, additional_elements=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_RecipientAccountWageGarnishment table.

wage_garnishment_id: int = -1

account_id: int = 0

disbursement_unit_name: str = ''

tax_type_short_name: str = ''

entry_type_short_name: str = ''

case_identifier: str | None = None

garnished_ssn: str | None = None

medical_support_indicator: bool | None = None

originator_reference_id: str | None = None

additional_elements: str | None = None

original_record: Q2RecipientAccountWageGarnishment | 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:: Q2RecipientAccountWageGarnishment

class q2_sdk.hq.hq_api.backoffice.AddRecipientsCse_models.Q2RecipientPending(pending_recipient_id=-1, recipient_id=0, change_status='', data=None, customer_id_=0, user_id=None, created_at='', approved=None, approved_id_=None, approved_at=None, approval_reason=None, noc_id=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_RecipientPending table.

pending_recipient_id: int = -1

recipient_id: int = 0

change_status: str = ''

data: str | None = None

customer_id_: int = 0

user_id: int | None = None

created_at: str = ''

approved: bool | None = None

approved_id_: int | None = None

approved_at: str | None = None

approval_reason: str | None = None

noc_id: str | None = None

original_record: Q2RecipientPending | 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:: Q2RecipientPending

class q2_sdk.hq.hq_api.backoffice.AddRecipientsCse_models.Q2User(user_id=-1, customer_id=0, first_name=None, middle_name=None, last_name=None, salutation=None, suffix=None, ssn=None, create_date='', deleted_date=None, default_email_id=None, default_address_id=None, auto_generated=False, host_user=None, host_pwd=None, user_info=None, profile_updated=None, mobile_auth_code=None, use_customer_accounts=False, primary_cif=None, last_user_profile_update=None, user_role_id=None, policy_id=None, user_status_id=0, status_change_date=None, dob=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_User table.

user_id: int = -1

customer_id: int = 0

first_name: str | None = None

middle_name: str | None = None

last_name: str | None = None

salutation: str | None = None

suffix: str | None = None

ssn: str | None = None

create_date: str = ''

deleted_date: str | None = None

default_email_id: int | None = None

default_address_id: int | None = None

auto_generated: bool = False

host_user: str | None = None

host_pwd: str | None = None

user_info: str | None = None

profile_updated: bool | None = None

mobile_auth_code: str | None = None

use_customer_accounts: bool = False

primary_cif: str | None = None

last_user_profile_update: str | None = None

user_role_id: int | None = None

policy_id: int | None = None

user_status_id: int = 0

status_change_date: str | None = None

dob: str | None = None

original_record: Q2User | 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:: Q2User

class q2_sdk.hq.hq_api.backoffice.AddRecipientsCse_models.Q2RecipientFiAdditionalDetail(recipient_fi_additional_detail_id=-1, recipient_fi_detail_id=0, transit_number=None, is_iat_enabled=False, is_wire_enabled=False, original_record=None)[source]

Bases: object

Represents a row in the Q2_RecipientFiAdditionalDetail table.

recipient_fi_additional_detail_id: int = -1

recipient_fi_detail_id: int = 0

transit_number: str | None = None

is_iat_enabled: bool = False

is_wire_enabled: bool = False

original_record: Q2RecipientFiAdditionalDetail | 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:: Q2RecipientFiAdditionalDetail

q2_sdk.hq.hq_api.backoffice.AddRecipientsCse_models.build_recipients_dataset(q2_recipient_account=None, q2_recipient_address=None, q2_recipient_fi_detail=None, q2_recipient=None, q2_recipient_account_wage_garnishment=None, q2_recipient_pending=None, q2_user=None, q2_recipient_fi_additional_detail=None)[source]

Build the recipients DataSet parameter for AddRecipientsCse.

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

For add operations, set auto-increment ID fields to negative values.

Return type:: DataSetBuilder
Returns:: DataSetBuilder ready to pass as the ‘recipients’ parameter