Online User
- class q2_sdk.hq.models.online_user.OnlineUser(request_xml=None, *, customer_key=None)[source]
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:
Optional
[int
]
-
customer_id:
Optional
[int
]
-
group_id:
Optional
[int
]
-
group_desc:
Optional
[str
]
-
login_name:
Optional
[str
]
-
customer_name:
Optional
[str
]
-
first_name:
Optional
[str
]
-
middle_name:
Optional
[str
]
-
last_name:
Optional
[str
]
-
ssn:
Optional
[str
]
-
email_address:
Optional
[str
]
-
city:
Optional
[str
]
-
state:
Optional
[str
]
-
language:
Optional
[str
]
-
postal_code:
Optional
[str
]
-
home_phone:
Optional
[str
]
-
mobile_phone:
Optional
[str
]
-
work_phone:
Optional
[str
]
-
hq_session_id:
Optional
[str
]
-
user_logon_id:
Optional
[int
]
-
customer_primary_cif:
Optional
[str
]
-
user_primary_cif:
Optional
[str
]
-
address1:
Optional
[str
]
-
address2:
Optional
[str
]
-
demographic_info:
Optional
[DemographicInfo
]
-
user_role_id:
Optional
[int
] 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:
Optional
[bool
] 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:
Optional
[bool
] This value is not present in the incoming request from HQ so it has to be set manually if needed.
-
is_commercial:
Optional
[bool
] This value is not present in the incoming request from HQ so it has to be set manually if needed.
-
dob:
Optional
[str
] 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:
Optional
[str
] A consistent ID for this user guaranteed to be unique across databases. Useful for multitenant extensions