UpdateCustomerWithAccountEdit models
DataSet models for UpdateCustomerWithAccountEdit.
These typed dataclass models represent the tables and columns within the DataSet parameters for the UpdateCustomerWithAccountEdit 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 UpdateCustomerWithAccountEdit
q2_customer = UpdateCustomerWithAccountEdit.Q2Customer(
customer_name="...",
is_company=True,
create_date="...",
auto_generated=True,
group_id=1,
charge_plan_start_date="...",
)
q2_phone_number = UpdateCustomerWithAccountEdit.Q2PhoneNumber(
country_id=1,
city_or_area_code="...",
local_number="...",
phone_type=1,
)
q2_customer_account = UpdateCustomerWithAccountEdit.Q2CustomerAccount(
customer_id=1,
access=1,
primary_only=True,
)
q2_customer_account_access_view = UpdateCustomerWithAccountEdit.Q2CustomerAccountAccessView(
customer_account_id=1,
customer_id=1,
current_access_flag=1,
)
q2_subsidiary_view = UpdateCustomerWithAccountEdit.Q2SubsidiaryView(
subsidiary_id=1,
customer_id=1,
display_name="...",
)
q2_address = UpdateCustomerWithAccountEdit.Q2Address(
street_address1="...",
city="...",
address_type=1,
country_id=1,
is_international=True,
)
transaction_rights = UpdateCustomerWithAccountEdit.TransactionRights(
transaction_type_id=1,
transaction_type="...",
description="...",
enabled=True,
authorize=True,
cancel=True,
create=True,
create_restricted=True,
update=True,
view=1,
limit_per_transaction=1.0,
limit_per_day=1.0,
limit_per_month=1.0,
limit_per_acct_per_day=1.0,
count_per_acct_per_day=1,
count_per_day=1,
count_per_month=1,
dual_approval_limit=1.0,
token_required_limit=1.0,
bit_flags=1,
)
user_rights = UpdateCustomerWithAccountEdit.UserRights(
rights_short_name="...",
rights_long_name="...",
has_rights=True,
)
user_monetary_rights = UpdateCustomerWithAccountEdit.UserMonetaryRights(
rights_short_name="...",
rights_long_name="...",
amount=1.0,
)
q2_customer_account_view = UpdateCustomerWithAccountEdit.Q2CustomerAccountView(
customer_account_id=1,
customer_id=1,
host_account_id=1,
account_number_internal="...",
product_name="...",
is_external_account=True,
product_id=1,
product_type_id=1,
user_access=1,
current_access_flag=1,
)
q2_acct_edit_customer_account = UpdateCustomerWithAccountEdit.Q2AcctEditCustomerAccount(
customer_account_id=1,
customer_id=1,
access=1,
primary_only=True,
)
q2_acct_edit_user_account = UpdateCustomerWithAccountEdit.Q2AcctEditUserAccount(
user_account_id=1,
user_id=1,
customer_account_id=1,
access=1,
)
q2_acct_edit_host_account = UpdateCustomerWithAccountEdit.Q2AcctEditHostAccount(
customer_account_id=1,
customer_id=1,
access=1,
host_account_id=1,
account_number_internal="...",
is_external_account=True,
)
q2_acct_edit_host_user_account = UpdateCustomerWithAccountEdit.Q2AcctEditHostUserAccount(
user_account_id=1,
user_id=1,
customer_account_id=1,
access=1,
customer_access=1,
valid_system_access_flag=1,
host_account_id=1,
account_number_internal="...",
is_external_account=True,
status_description="...",
host_product_code="...",
product_name="...",
hydra_product_code="...",
product_type_name="...",
hydra_product_type_code="...",
)
q2_acct_edit_host_user_role_account = UpdateCustomerWithAccountEdit.Q2AcctEditHostUserRoleAccount(
user_role_account_id=1,
user_role_id=1,
customer_account_id=1,
access=1,
customer_access=1,
valid_system_access_flag=1,
host_account_id=1,
account_number_internal="...",
is_external_account=True,
status_description="...",
host_product_code="...",
product_name="...",
hydra_product_code="...",
product_type_name="...",
hydra_product_type_code="...",
)
q2_acct_edit_user_role_account = UpdateCustomerWithAccountEdit.Q2AcctEditUserRoleAccount(
user_role_account_id=1,
user_role_id=1,
customer_account_id=1,
access=1,
)
- class q2_sdk.hq.hq_api.backoffice.UpdateCustomerWithAccountEdit_models.Q2Customer(customer_id=-1, customer_name='', tax_id=None, is_company=False, service_charge_plan_id=None, charge_account=None, create_date='', default_address_id=None, auto_generated=False, deleted_date=None, group_id=0, charge_plan_start_date='', cust_info=None, primary_cif=None, policy_id=None, company_policy_id=None, host_user=None, host_pwd=None, legal_entity_identifier=None, host_account_not_allowed_for_ach=None, restricted_entitlement_profile_id=None, restricted_entitlement_last_change=None, original_record=None)[source]
Bases:
objectRepresents a row in the Q2_Customer table.
- original_record: Q2Customer | None = None
- class q2_sdk.hq.hq_api.backoffice.UpdateCustomerWithAccountEdit_models.Q2PhoneNumber(phone_id=-1, country_id=0, city_or_area_code='', local_number='', extension=None, phone_type=0, user_id=None, customer_id=None, original_record=None)[source]
Bases:
objectRepresents a row in the Q2_PhoneNumber table.
- original_record: Q2PhoneNumber | None = None
- class q2_sdk.hq.hq_api.backoffice.UpdateCustomerWithAccountEdit_models.Q2CustomerAccount(customer_account_id=-1, customer_id=0, host_internal_cif=None, host_account_id=None, access=0, primary_only=False, original_record=None)[source]
Bases:
objectRepresents a row in the Q2_CustomerAccount table.
- original_record: Q2CustomerAccount | None = None
- class q2_sdk.hq.hq_api.backoffice.UpdateCustomerWithAccountEdit_models.Q2CustomerAccountAccessView(customer_account_id=0, customer_id=0, host_internal_cif=None, host_account_id=None, product_id=None, product_type_id=None, current_access_flag=0, valid_system_access_flag=None, original_record=None)[source]
Bases:
objectRepresents a row in the Q2_CustomerAccountAccessView table.
- original_record: Q2CustomerAccountAccessView | None = None
- class q2_sdk.hq.hq_api.backoffice.UpdateCustomerWithAccountEdit_models.Q2SubsidiaryView(subsidiary_id=0, customer_id=0, display_name='', ach_name=None, ach_tax_id=None, wire_name=None, wire_address1=None, wire_address2=None, wire_city=None, wire_state=None, wire_postal_code=None, wire_country_id=None, wire_is_international=None, wire_province=None, wire_address_id=None, original_record=None)[source]
Bases:
objectRepresents a row in the Q2_SubsidiaryView table.
- original_record: Q2SubsidiaryView | None = None
- class q2_sdk.hq.hq_api.backoffice.UpdateCustomerWithAccountEdit_models.Q2Address(address_id=-1, street_address1='', street_address2=None, city='', state=None, postal_code=None, customer_id=None, address_type=0, user_id=None, country_id=0, is_international=False, province=None, original_record=None)[source]
Bases:
objectRepresents a row in the Q2_Address table.
- class q2_sdk.hq.hq_api.backoffice.UpdateCustomerWithAccountEdit_models.TransactionRights(transaction_type_id=0, transaction_type='', description='', enabled=False, authorize=False, cancel=False, create=False, create_restricted=False, update=False, view=0, limit_per_transaction=0.0, limit_per_day=0.0, limit_per_month=0.0, limit_per_acct_per_day=0.0, count_per_acct_per_day=0, count_per_day=0, count_per_month=0, dual_approval_limit=0.0, token_required_limit=0.0, bit_flags=0, original_record=None)[source]
Bases:
objectRepresents a row in the TransactionRights table.
- original_record: TransactionRights | None = None
- class q2_sdk.hq.hq_api.backoffice.UpdateCustomerWithAccountEdit_models.UserRights(rights_short_name='', rights_long_name='', has_rights=False, original_record=None)[source]
Bases:
objectRepresents a row in the UserRights table.
- original_record: UserRights | None = None
- class q2_sdk.hq.hq_api.backoffice.UpdateCustomerWithAccountEdit_models.UserMonetaryRights(rights_short_name='', rights_long_name='', amount=0.0, original_record=None)[source]
Bases:
objectRepresents a row in the UserMonetaryRights table.
- original_record: UserMonetaryRights | None = None
- class q2_sdk.hq.hq_api.backoffice.UpdateCustomerWithAccountEdit_models.Q2CustomerAccountView(customer_account_id=0, customer_id=0, is_cif_rel=None, host_account_id=0, account_number_internal='', product_name='', is_user_enabled=None, is_external_account=False, product_id=0, product_type_id=0, user_access=0, current_access_flag=0, valid_customer_access_flag=None, valid_system_access_flag=None, original_record=None)[source]
Bases:
objectRepresents a row in the Q2_CustomerAccountView table.
- original_record: Q2CustomerAccountView | None = None
- class q2_sdk.hq.hq_api.backoffice.UpdateCustomerWithAccountEdit_models.Q2AcctEditCustomerAccount(customer_account_id=0, customer_id=0, host_internal_cif=None, host_account_id=None, access=0, primary_only=False, is_external_account=None, original_record=None)[source]
Bases:
objectRepresents a row in the Q2_AcctEditCustomerAccount table.
- original_record: Q2AcctEditCustomerAccount | None = None
- class q2_sdk.hq.hq_api.backoffice.UpdateCustomerWithAccountEdit_models.Q2AcctEditUserAccount(user_account_id=0, user_id=0, customer_account_id=0, access=0, host_account_id=None, is_external_account=None, original_record=None)[source]
Bases:
objectRepresents a row in the Q2_AcctEditUserAccount table.
- original_record: Q2AcctEditUserAccount | None = None
- class q2_sdk.hq.hq_api.backoffice.UpdateCustomerWithAccountEdit_models.Q2AcctEditHostAccount(customer_account_id=0, customer_id=0, access=0, valid_system_access_flag=None, host_account_id=0, account_number_internal='', account_number_external=None, account_desc=None, cif_internal=None, cif_external=None, is_external_account=False, status_description=None, host_product_code=None, product_name=None, product_nick_name=None, hydra_product_code=None, product_type_name=None, hydra_product_type_code=None, host_product_type_code=None, host_branch=None, branch_name=None, aba=None, end_user_masked_account=None, relationship_cif=None, original_record=None)[source]
Bases:
objectRepresents a row in the Q2_AcctEditHostAccount table.
- original_record: Q2AcctEditHostAccount | None = None
- class q2_sdk.hq.hq_api.backoffice.UpdateCustomerWithAccountEdit_models.Q2AcctEditHostUserAccount(user_account_id=0, user_id=0, customer_account_id=0, access=0, customer_access=0, valid_system_access_flag=0, user_relation_id=None, customer_relation_id=None, host_account_id=0, account_number_internal='', account_number_external=None, account_desc=None, cif_internal=None, cif_external=None, is_external_account=False, aba=None, status_description='', host_product_code='', product_name='', product_nick_name=None, hydra_product_code='', product_type_name='', hydra_product_type_code='', host_product_type_code=None, host_branch=None, branch_name=None, original_record=None)[source]
Bases:
objectRepresents a row in the Q2_AcctEditHostUserAccount table.
- original_record: Q2AcctEditHostUserAccount | None = None
- class q2_sdk.hq.hq_api.backoffice.UpdateCustomerWithAccountEdit_models.Q2AcctEditHostUserRoleAccount(user_role_account_id=0, user_role_id=0, customer_account_id=0, access=0, customer_access=0, valid_system_access_flag=0, user_relation_id=None, customer_relation_id=None, host_account_id=0, account_number_internal='', account_number_external=None, account_desc=None, cif_internal=None, cif_external=None, is_external_account=False, aba=None, status_description='', host_product_code='', product_name='', product_nick_name=None, hydra_product_code='', product_type_name='', hydra_product_type_code='', host_product_type_code=None, host_branch=None, branch_name=None, end_user_masked_account=None, relationship_cif=None, original_record=None)[source]
Bases:
objectRepresents a row in the Q2_AcctEditHostUserRoleAccount table.
- original_record: Q2AcctEditHostUserRoleAccount | None = None
- class q2_sdk.hq.hq_api.backoffice.UpdateCustomerWithAccountEdit_models.Q2AcctEditUserRoleAccount(user_role_account_id=0, user_role_id=0, customer_account_id=0, access=0, host_account_id=None, is_external_account=None, original_record=None)[source]
Bases:
objectRepresents a row in the Q2_AcctEditUserRoleAccount table.
- original_record: Q2AcctEditUserRoleAccount | None = None
- q2_sdk.hq.hq_api.backoffice.UpdateCustomerWithAccountEdit_models.build_dal_customer_edit_dataset(q2_customer=None, q2_phone_number=None, q2_customer_account=None, q2_customer_account_access_view=None, q2_subsidiary_view=None, q2_address=None)[source]
Build the dal_customer_edit DataSet parameter for UpdateCustomerWithAccountEdit.
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:
- Returns:
DataSetBuilder ready to pass as the ‘dal_customer_edit’ parameter
- q2_sdk.hq.hq_api.backoffice.UpdateCustomerWithAccountEdit_models.build_customer_rights_dataset(transaction_rights=None, user_rights=None, user_monetary_rights=None, q2_customer_account_view=None)[source]
Build the customer_rights DataSet parameter for UpdateCustomerWithAccountEdit.
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:
- Returns:
DataSetBuilder ready to pass as the ‘customer_rights’ parameter
- q2_sdk.hq.hq_api.backoffice.UpdateCustomerWithAccountEdit_models.build_account_edit_dataset(q2_acct_edit_customer_account=None, q2_acct_edit_user_account=None, q2_acct_edit_host_account=None, q2_acct_edit_host_user_account=None, q2_acct_edit_host_user_role_account=None, q2_acct_edit_user_role_account=None)[source]
Build the account_edit DataSet parameter for UpdateCustomerWithAccountEdit.
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:
- Returns:
DataSetBuilder ready to pass as the ‘account_edit’ parameter