Online User

class q2_sdk.hq.models.online_user.OnlineUser(request_xml=None, *, customer_key=None)

Object representation of the User information that comes in on a Q2 Online request

Parameters:

request_xml (Optional[Element]) – XML node from Q2 Online request

user_id: int | None

customer_id: int | None

group_id: int | None

group_desc: str | None

login_name: str | None

customer_name: str | None

first_name: str | None

middle_name: str | None

last_name: str | None

ssn: str | None

email_address: str | None

city: str | None

state: str | None

language: str | None

postal_code: str | None

home_phone: str | None

mobile_phone: str | None

work_phone: str | None

hq_session_id: str | None

user_logon_id: int | None

customer_primary_cif: str | None

user_primary_cif: str | None

address1: str | None

address2: str | None

demographic_info: DemographicInfo | None

user_role_id: int | None

This value is not present in the incoming request from HQ so it has to be set manually if needed. You can use the get_user_role method provided in online form extensions

is_company: bool | None

This value is not present in the incoming request from HQ so it has to be set manually if needed. It can be used to provide core mappers additional context for making calls.

is_treasury: bool | None

This value is not present in the incoming request from HQ so it has to be set manually if needed.

is_commercial: bool | None

This value is not present in the incoming request from HQ so it has to be set manually if needed.

dob: str | None

This value is not present in the incoming request from HQ so it has to be set manually if needed. You can use the get_user_dob method provided in online form extensions

user_guid: str | None

A consistent ID for this user guaranteed to be unique across databases. Useful for multitenant extensions