EmployeeAdd

This adds an employee to QBPOS, similar to adding an employee from the QBPOS UI in the employee and security preferences. This Add request in the SDK, however, does not allow you to assign the employee to specific groups: instead, the employee is assigned by default to the Associate group. You still need to do this from within the UI, and you still need to assign passwords from within the QBPOS UI. Notice that Employee supports custom fields, so you can add additional information to the employee record if you want.


Request

Response

XMLOPS

VB.NET

C#

Tag Type Max length Implementation Required

IEmployeeAdd

This adds an employee to QBPOS, similar to adding an employee from the QBPOS UI in the employee and security preferences. This Add request in the SDK, however, does not allow you to assign the employee to specific groups: instead, the employee is assigned by default to the Associate group. You still need to do this from within the UI, and you still need to assign passwords from within the QBPOS UI. Notice that Employee supports custom fields, so you can add additional information to the employee record if you want.
     1.1  

defMacro

You use a macro in a request message set if you need to create some object in one request, then refer to it in a subsequent request within that same message set. For example, you could create an inventory item and then include that item as a line item in a sales order all in one request message set, rather than create the item, query for it, then include it in a separate SalesOrderAdd request. In this latter case, you are accessing QBPOS three times, versus only once, using macros. The item to be referenced is specified via the defmacro. The actual reference to that item in the succeeding request is done via the use macro, as follows: ItemInventoryAdd defMacro=”ListID:Inv1” In the above line, you simply replace Inv1 with the name you want to give the macro. When you reference this macro in another request (one that requires that object’s listID) in the same message set, you use this syntax: ListID useMacro=”ListID:Inv1” This is covered in more detail in the Programming Guide.
 IQBStringType   2.0  

City

The city name in the address.
 IQBStringType 31 chars    

CommissionPercent

If sales commissions are paid to this employees, this number specifies the percentage of that commission. You can enter numbers in the range from 0.00 to 99.99.
 IQBFloatType      

Country

The country of residence of this employee.
 IQBStringType 31 chars    

EMail

The email address.
 IQBStringType 99 chars    

FirstName

The first name.
 IQBStringType 30 chars    

IsTrackingHours

Indicates whether time is tracked for this employee.
 IQBBoolType   2.0  

LastName

The last name.
 IQBStringType 30 chars    

LoginName

The name this employee will use to log in to QBPOS. Because QBPOS requires that all employee login names be unique, QBPOS will append a number to the end of any login name that is the same as an existing one.The following information applies only if you are using QBPOS together with QuickBooks: If there is both a first name and a last name for the employee in QuickBooks, then this Login Name in QBPOS should be set to the first initial of the first name plus the entire last name. If only a first name or only a last name exists for an employee in QuickBooks, then that name should be used as the Login Name in QBPOS.
 IQBStringType 20 chars   Y

Notes

Use this field to record optional information about the object, such as employee or customer, such as birthday, requested items, clothing sizes, etc. Notice that notes are not exchanged with QuickBooks Financial Software.
 IQBStringType 245 chars    

Phone

Primary Telephone number of this person or entity.
 IQBStringType 40 chars    

Phone2

Alternate phone number or fax number for this person or entity. This maps to Phone 2 in the QBPOS UI.
 IQBStringType 40 chars    

Phone3

Alternate phone number or fax number for this person or entity. This maps to Alt. Phone in the QBPOS UI.
 IQBStringType 40 chars    

Phone4

Alternate phone number, fax number, or other contact information for this person or entity. This maps to Alt. Contact in the QBPOS UI.
 IQBStringType 40 chars    

PostalCode

The postal code used in the address.
 IQBStringType 13 chars    

State

The state name in the address.
 IQBStringType 21 chars    

Street

Street Address of the vendor, customer, or other addressee.
 IQBStringType 41 chars    

Street2

Street Address of the vendor, customer, or other addressee.
 IQBStringType 41 chars 3.0  

SecurityGroup

You control access by assigning your employees to security groups; each group having a different set of access rights. Point of Sale comes with four predefined security groups that you can assign. If the default rights in the four predefined groups don’t meet your needs, you can easily change them or set up new groups with access rights of your choosing.
 IQBStringType 40 chars 2.5  

IncludeRetElementList

You can use the IncludeRetElement feature to restrict the data returned in the response to the specified qbposXML field here. If you do this, only those elements specified will be returned. To use this feature, you simply add the qbposXML element name to the IncludeRetElementList. The following example shows how to do this, specifying that only the CreatedBy and ClockOutTime elements are to be returned in the TimeEntryAdd response: Dim MyTimeEntry As ITimeEntryAdd Set MyTimeEntry = requestMsgSet.AppendTimeEntryAddRq MyTimeEntry.IncludeRetElementList.Add “CreatedBy” MyTimeEntry.IncludeRetElementList.Add “ClockOutTime” ‘ set the other properties as desired…
 IBSTRList 50 chars 2.0  
Tag Type Max length Implementation Required

IResponse

This adds an employee to QBPOS, similar to adding an employee from the QBPOS UI in the employee and security preferences. This Add request in the SDK, however, does not allow you to assign the employee to specific groups: instead, the employee is assigned by default to the Associate group. You still need to do this from within the UI, and you still need to assign passwords from within the QBPOS UI. Notice that Employee supports custom fields, so you can add additional information to the employee record if you want.
     1.1  

StatusCode

A number that corresponds to a statusSeverity and statusMessage. Five status codes relate directly to signon messages: 2000, 2010, 2020, 2030, and 2040. For details about these and other statusCode values that can be returned, see the statusCode table on the Error Codes page.
 IQBIntType     Y

StatusSeverity

One of the following values: INFO The request was completed, and the results are consistent with what your application expected. WARNING The request was completed, but the results might not be consistent with what you expected. ERROR The request was not completed. No data will appear in the server’s response after the statusMessage.
 IQBStringType     Y

StatusMessage

A user-readable explanation of the success or error condition that is indicated by the statusCode. For details about the statusMessage values that can be returned, see the “Explanation” column of the statusCode table on the Error Codes page.
 IQBStringType     Y

Detail

 IEmployeeRet      

ListID

The unique ID returned by QBPOS for this object. If supplied in a request, the ListID is a reference to an object required in the request. For example, in a SalesOrder or PurchaseOrder line item, the ListID that is required is an Item list ID.
 IQBIDType      

TimeCreated

The timestamp indicating the time when this object was created in QBPOS.
 IQBDateTimeType      

TimeModified

The time when the object was modified by QBPOS.
 IQBDateTimeType      

City

The city name in the address.
 IQBStringType 31 chars    

CommissionPercent

If sales commissions are paid to this employees, this number specifies the percentage of that commission. You can enter numbers in the range from 0.00 to 99.99.
 IQBFloatType      

Country

The country of residence of this employee.
 IQBStringType 31 chars    

EMail

The email address.
 IQBStringType 99 chars    

FirstName

The first name.
 IQBStringType 30 chars    

IsTrackingHours

Indicates whether time is tracked for this employee.
 IQBBoolType   2.0  

LastName

The last name.
 IQBStringType 30 chars    

LoginName

The name this employee will use to log in to QBPOS. Because QBPOS requires that all employee login names be unique, QBPOS will append a number to the end of any login name that is the same as an existing one.The following information applies only if you are using QBPOS together with QuickBooks: If there is both a first name and a last name for the employee in QuickBooks, then this Login Name in QBPOS should be set to the first initial of the first name plus the entire last name. If only a first name or only a last name exists for an employee in QuickBooks, then that name should be used as the Login Name in QBPOS.
 IQBStringType 20 chars    

Notes

Use this field to record optional information about the object, such as employee or customer, such as birthday, requested items, clothing sizes, etc. Notice that notes are not exchanged with QuickBooks Financial Software.
 IQBStringType 245 chars    

Phone

Primary Telephone number of this person or entity.
 IQBStringType 40 chars    

Phone2

Alternate phone number or fax number for this person or entity. This maps to Phone 2 in the QBPOS UI.
 IQBStringType 40 chars    

Phone3

Alternate phone number or fax number for this person or entity. This maps to Alt. Phone in the QBPOS UI.
 IQBStringType 40 chars    

Phone4

Alternate phone number, fax number, or other contact information for this person or entity. This maps to Alt. Contact in the QBPOS UI.
 IQBStringType 40 chars    

PostalCode

The postal code used in the address.
 IQBStringType 13 chars    

State

The state name in the address.
 IQBStringType 21 chars    

Street

Street Address of the vendor, customer, or other addressee.
 IQBStringType 41 chars    

Street2

Street Address of the vendor, customer, or other addressee.
 IQBStringType 41 chars 3.0  

SecurityGroup

You control access by assigning your employees to security groups; each group having a different set of access rights. Point of Sale comes with four predefined security groups that you can assign. If the default rights in the four predefined groups don’t meet your needs, you can easily change them or set up new groups with access rights of your choosing.
 IQBStringType 40 chars 2.5  

DataExtRetList

If you specify any custom fields/private data extensions to be returned in the query request (in the OwnerIDList), then this Ret List will contain all of the data extensions that belong to each specified OwnerID. For example, if you specify an OwnerID value of 0 (custom fields), then the query will return all custom data for the returned records.
 IDataExtRetList   1.2  

(List of IDataExtRet Objects)

        

OwnerID

OwnerID refers to the owner of a data extension, and must be 0 or a valid GUID. (Custom fields, which are visible in the QuickBooks UI, always have an OwnerID of 0. ) Usually you would keep your application’s GUID confidential to prevent other applications from accessing your data extensions. But if you want to share data extensions with another application, the applications need to use the same GUID. In this case, each application could use two GUIDs, one for shared data extensions and one for confidential data extensions. (An application can have any number of GUIDs.) When you share a data extension with another application, the other application must know both the OwnerID and the DataExtName, as these together form a data extension’s unique name.
 IQBGUIDType     Y

DataExtName

The name of the data extension. If this is a custom field, DataExtName will be visible as a label in the QuickBooks user interface. Also because OwnerID and DataExtName together make the data extension unique, and because custom fields all have the same OwnerID of zero, the DataExtName must be a unique value among existing custom fields. In contrast, the DataExtName for private data extensions must be unique only for the specified OwnerID GUID.
 IQBStringType     Y

DataExtType

b>DataExtType The type of the data extension.
 IQBENDataExtTypeType     Y

DataExtValue

The data in this field. The maximum length of DataExtValue will depend on the DataExtType of this data extension. For example, if DataExtType is STR255TYPE, the maximum length of DataExtValue is 255 characters. If DataExtType is STR1024TYPE, the maximum size of DataExtValue is 1KB.
 IQBStringType     Y 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
<?xml version="1.0" encoding="utf-8"?>
<?qbposxml version="4.0"?>
<QBPOSXML>
        <QBPOSXMLMsgsRq onError="stopOnError">
                <EmployeeAddRq>
                        <EmployeeAdd defMacro="MACROTYPE"> <!-- required -->
                                <City >STRTYPE</City> <!-- optional -->
                                <CommissionPercent >FLOATTYPE</CommissionPercent> <!-- optional -->
                                <Country >STRTYPE</Country> <!-- optional -->
                                <EMail >STRTYPE</EMail> <!-- optional -->
                                <FirstName >STRTYPE</FirstName> <!-- optional -->
                                <IsTrackingHours >BOOLTYPE</IsTrackingHours> <!-- optional -->
                                <LastName >STRTYPE</LastName> <!-- optional -->
                                <LoginName >STRTYPE</LoginName> <!-- required -->
                                <Notes >STRTYPE</Notes> <!-- optional -->
                                <Phone >STRTYPE</Phone> <!-- optional -->
                                <Phone2 >STRTYPE</Phone2> <!-- optional -->
                                <Phone3 >STRTYPE</Phone3> <!-- optional -->
                                <Phone4 >STRTYPE</Phone4> <!-- optional -->
                                <PostalCode >STRTYPE</PostalCode> <!-- optional -->
                                <State >STRTYPE</State> <!-- optional -->
                                <Street >STRTYPE</Street> <!-- optional -->
                                <Street2 >STRTYPE</Street2> <!-- optional -->
                                <SecurityGroup >STRTYPE</SecurityGroup> <!-- optional -->
                        </EmployeeAdd>
                        <IncludeRetElement >STRTYPE</IncludeRetElement> <!-- optional, may repeat -->
                </EmployeeAddRq>

                <EmployeeAddRs statusCode="INTTYPE" statusSeverity="STRTYPE" statusMessage="STRTYPE">
                        <EmployeeRet> <!-- optional -->
                                <ListID >IDTYPE</ListID> <!-- optional -->
                                <TimeCreated >DATETIMETYPE</TimeCreated> <!-- optional -->
                                <TimeModified >DATETIMETYPE</TimeModified> <!-- optional -->
                                <City >STRTYPE</City> <!-- optional -->
                                <CommissionPercent >FLOATTYPE</CommissionPercent> <!-- optional -->
                                <Country >STRTYPE</Country> <!-- optional -->
                                <EMail >STRTYPE</EMail> <!-- optional -->
                                <FirstName >STRTYPE</FirstName> <!-- optional -->
                                <IsTrackingHours >BOOLTYPE</IsTrackingHours> <!-- optional -->
                                <LastName >STRTYPE</LastName> <!-- optional -->
                                <LoginName >STRTYPE</LoginName> <!-- optional -->
                                <Notes >STRTYPE</Notes> <!-- optional -->
                                <Phone >STRTYPE</Phone> <!-- optional -->
                                <Phone2 >STRTYPE</Phone2> <!-- optional -->
                                <Phone3 >STRTYPE</Phone3> <!-- optional -->
                                <Phone4 >STRTYPE</Phone4> <!-- optional -->
                                <PostalCode >STRTYPE</PostalCode> <!-- optional -->
                                <State >STRTYPE</State> <!-- optional -->
                                <Street >STRTYPE</Street> <!-- optional -->
                                <Street2 >STRTYPE</Street2> <!-- optional -->
                                <SecurityGroup >STRTYPE</SecurityGroup> <!-- optional -->
                                <DataExtRet> <!-- optional, may repeat -->
                                        <OwnerID >GUIDTYPE</OwnerID> <!-- required -->
                                        <DataExtName >STRTYPE</DataExtName> <!-- required -->
                                        <!-- DataExtType may have one of the following values: INTTYPE, AMTTYPE, PRICETYPE, QUANTYPE, PERCENTTYPE, DATETIMETYPE, STR255TYPE, STR1024TYPE -->
                                        <DataExtType >ENUMTYPE</DataExtType> <!-- required -->
                                        <DataExtValue >STRTYPE</DataExtValue> <!-- required -->
                                </DataExtRet>
                        </EmployeeRet>
                </EmployeeAddRs>
        </QBPOSXMLMsgsRq>
</QBPOSXML>


  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
'The following sample code is generated as an illustration of
'Creating requests and parsing responses ONLY
'This code is NOT intended to show best practices or ideal code
'Use at your most careful discretion

imports System
imports System.Net
imports System.Drawing
imports System.Collections
imports System.ComponentModel
imports System.Windows.Forms
imports System.Data
imports System.IO
imports Interop.qbposfc4

        Public Class SampleEmployeeAdd
                Public Sub  DoEmployeeAdd()
                        Dim sessionBegun as Boolean
                        sessionBegun = False
                        Dim connectionOpen as Boolean
                        connectionOpen = False
                        Dim sessionManager as QBPOSSessionManager
                        sessionManager = nothing

                        Try
                                'Create the session Manager object
                                sessionManager = new QBPOSSessionManager

                                'Create the message set request object to hold our request
                                Dim requestMsgSet as IMsgSetRequest
                                requestMsgSet = sessionManager.CreateMsgSetRequest(4,0)
                                requestMsgSet.Attributes.OnError = ENRqOnError.roeContinue

                                BuildEmployeeAddRq(requestMsgSet)

                                'Connect to QuickBooks and begin a session
                                sessionManager.OpenConnection("","Sample Code from OSR")
                                connectionOpen = True
                                sessionManager.BeginSession("")
                                sessionBegun = True

                                'Send the request and get the response from QuickBooks
                                Dim responseMsgSet as IMsgSetResponse
                                responseMsgSet = sessionManager.DoRequests(requestMsgSet)

                                'End the session and close the connection to QuickBooks
                                sessionManager.EndSession()
                                sessionBegun = False
                                sessionManager.CloseConnection()
                                connectionOpen = False

                                WalkEmployeeAddRs(responseMsgSet)
                        Catch e as Exception
                                MessageBox.Show(e.Message, "Error")
                                if (sessionBegun) then
                                        sessionManager.EndSession()
                                End If
                                if (connectionOpen) then
                                        sessionManager.CloseConnection()
                                End If
                        End Try
                End Sub
                Public Sub BuildEmployeeAddRq(requestMsgSet as IMsgSetRequest)
                        Dim EmployeeAddRq as IEmployeeAdd
                        EmployeeAddRq= requestMsgSet.AppendEmployeeAddRq()
                        'Set field value for City
                        EmployeeAddRq.City.SetValue("ab")
                        'Set field value for CommissionPercent
                        EmployeeAddRq.CommissionPercent.SetValue(12.34)
                        'Set field value for Country
                        EmployeeAddRq.Country.SetValue("ab")
                        'Set field value for EMail
                        EmployeeAddRq.EMail.SetValue("ab")
                        'Set field value for FirstName
                        EmployeeAddRq.FirstName.SetValue("ab")
                        'Set field value for IsTrackingHours
                        EmployeeAddRq.IsTrackingHours.SetValue(True)
                        'Set field value for LastName
                        EmployeeAddRq.LastName.SetValue("ab")
                        'Set field value for LoginName
                        EmployeeAddRq.LoginName.SetValue("ab")
                        'Set field value for Notes
                        EmployeeAddRq.Notes.SetValue("ab")
                        'Set field value for Phone
                        EmployeeAddRq.Phone.SetValue("ab")
                        'Set field value for Phone2
                        EmployeeAddRq.Phone2.SetValue("ab")
                        'Set field value for Phone3
                        EmployeeAddRq.Phone3.SetValue("ab")
                        'Set field value for Phone4
                        EmployeeAddRq.Phone4.SetValue("ab")
                        'Set field value for PostalCode
                        EmployeeAddRq.PostalCode.SetValue("ab")
                        'Set field value for State
                        EmployeeAddRq.State.SetValue("ab")
                        'Set field value for Street
                        EmployeeAddRq.Street.SetValue("ab")
                        'Set field value for Street2
                        EmployeeAddRq.Street2.SetValue("ab")
                        'Set field value for SecurityGroup
                        EmployeeAddRq.SecurityGroup.SetValue("ab")
                        'Set field value for IncludeRetElementList
                        'May create more than one of these if needed
                        EmployeeAddRq.IncludeRetElementList.Add("ab")
                End Sub




                Public Sub WalkEmployeeAddRs( responseMsgSet as IMsgSetResponse)
                        if (responseMsgSet is nothing) then
                                Exit Sub
                        End If

                        Dim responseList as IResponseList
                        responseList = responseMsgSet.ResponseList
                        if (responseList is nothing) then
                                Exit Sub
                        End If

                        'if we sent only one request, there is only one response, we'll walk the list for this sample
                        for j=0 to responseList.Count-1
                                Dim response as IResponse
                                response = responseList.GetAt(j)
                                'check the status code of the response, 0=ok, >0 is warning
                                if (response.StatusCode >= 0) then
                                        'the request-specific response is in the details, make sure we have some
                                        if (not response.Detail is nothing) then
                                                'make sure the response is the type we're expecting
                                                Dim responseType as ENResponseType
                                                responseType = CType(response.Type.GetValue(),ENResponseType)
                                                if (responseType = ENResponseType.rtEmployeeAddRs) then
                                                        'upcast to more specific type here, this is safe because we checked with response.Type check above
                                                        Dim EmployeeRet as IEmployeeRet
                                                        EmployeeRet = CType(response.Detail,IEmployeeRet)
                                                                WalkEmployeeRet(EmployeeRet)
                                                End If
                                        End If
                                End If
                        Next j
                End Sub




                Public Sub WalkEmployeeRet(EmployeeRet as IEmployeeRet)
                        if (EmployeeRet is nothing) then
                                Exit Sub
                        End If

                        'Go through all the elements of IEmployeeRet
                        'Get value of ListID
                        if ( not EmployeeRet.ListID is nothing) then
                                Dim ListID697 as String
                                ListID697 = EmployeeRet.ListID.GetValue()
                        End If
                        'Get value of TimeCreated
                        if ( not EmployeeRet.TimeCreated is nothing) then
                                Dim TimeCreated698 as DateTime
                                TimeCreated698 = EmployeeRet.TimeCreated.GetValue()
                        End If
                        'Get value of TimeModified
                        if ( not EmployeeRet.TimeModified is nothing) then
                                Dim TimeModified699 as DateTime
                                TimeModified699 = EmployeeRet.TimeModified.GetValue()
                        End If
                        'Get value of City
                        if ( not EmployeeRet.City is nothing) then
                                Dim City700 as String
                                City700 = EmployeeRet.City.GetValue()
                        End If
                        'Get value of CommissionPercent
                        if ( not EmployeeRet.CommissionPercent is nothing) then
                                Dim CommissionPercent701 as Single
                                CommissionPercent701 = EmployeeRet.CommissionPercent.GetValue()
                        End If
                        'Get value of Country
                        if ( not EmployeeRet.Country is nothing) then
                                Dim Country702 as String
                                Country702 = EmployeeRet.Country.GetValue()
                        End If
                        'Get value of EMail
                        if ( not EmployeeRet.EMail is nothing) then
                                Dim EMail703 as String
                                EMail703 = EmployeeRet.EMail.GetValue()
                        End If
                        'Get value of FirstName
                        if ( not EmployeeRet.FirstName is nothing) then
                                Dim FirstName704 as String
                                FirstName704 = EmployeeRet.FirstName.GetValue()
                        End If
                        'Get value of IsTrackingHours
                        if ( not EmployeeRet.IsTrackingHours is nothing) then
                                Dim IsTrackingHours705 as Boolean
                                IsTrackingHours705 = EmployeeRet.IsTrackingHours.GetValue()
                        End If
                        'Get value of LastName
                        if ( not EmployeeRet.LastName is nothing) then
                                Dim LastName706 as String
                                LastName706 = EmployeeRet.LastName.GetValue()
                        End If
                        'Get value of LoginName
                        if ( not EmployeeRet.LoginName is nothing) then
                                Dim LoginName707 as String
                                LoginName707 = EmployeeRet.LoginName.GetValue()
                        End If
                        'Get value of Notes
                        if ( not EmployeeRet.Notes is nothing) then
                                Dim Notes708 as String
                                Notes708 = EmployeeRet.Notes.GetValue()
                        End If
                        'Get value of Phone
                        if ( not EmployeeRet.Phone is nothing) then
                                Dim Phone709 as String
                                Phone709 = EmployeeRet.Phone.GetValue()
                        End If
                        'Get value of Phone2
                        if ( not EmployeeRet.Phone2 is nothing) then
                                Dim Phone2710 as String
                                Phone2710 = EmployeeRet.Phone2.GetValue()
                        End If
                        'Get value of Phone3
                        if ( not EmployeeRet.Phone3 is nothing) then
                                Dim Phone3711 as String
                                Phone3711 = EmployeeRet.Phone3.GetValue()
                        End If
                        'Get value of Phone4
                        if ( not EmployeeRet.Phone4 is nothing) then
                                Dim Phone4712 as String
                                Phone4712 = EmployeeRet.Phone4.GetValue()
                        End If
                        'Get value of PostalCode
                        if ( not EmployeeRet.PostalCode is nothing) then
                                Dim PostalCode713 as String
                                PostalCode713 = EmployeeRet.PostalCode.GetValue()
                        End If
                        'Get value of State
                        if ( not EmployeeRet.State is nothing) then
                                Dim State714 as String
                                State714 = EmployeeRet.State.GetValue()
                        End If
                        'Get value of Street
                        if ( not EmployeeRet.Street is nothing) then
                                Dim Street715 as String
                                Street715 = EmployeeRet.Street.GetValue()
                        End If
                        'Get value of Street2
                        if ( not EmployeeRet.Street2 is nothing) then
                                Dim Street2716 as String
                                Street2716 = EmployeeRet.Street2.GetValue()
                        End If
                        'Get value of SecurityGroup
                        if ( not EmployeeRet.SecurityGroup is nothing) then
                                Dim SecurityGroup717 as String
                                SecurityGroup717 = EmployeeRet.SecurityGroup.GetValue()
                        End If
                        if (not EmployeeRet.DataExtRetList is nothing)
                                Dim i718 as Integer
                                for i718 = 0  to EmployeeRet.DataExtRetList.Count - 1
                                        Dim DataExtRet as IDataExtRet
                                        DataExtRet = EmployeeRet.DataExtRetList.GetAt(i718)
                                        'Get value of OwnerID
                                        Dim OwnerID719 as String
                                        OwnerID719 = DataExtRet.OwnerID.GetValue()
                                        'Get value of DataExtName
                                        Dim DataExtName720 as String
                                        DataExtName720 = DataExtRet.DataExtName.GetValue()
                                        'Get value of DataExtType
                                        Dim DataExtType721 as ENDataExtType
                                        DataExtType721 = DataExtRet.DataExtType.GetValue()
                                        'Get value of DataExtValue
                                        Dim DataExtValue722 as String
                                        DataExtValue722 = DataExtRet.DataExtValue.GetValue()
                                Next i718
                        End If
                End Sub




        End Class


  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
//The following sample code is generated as an illustration of
//Creating requests and parsing responses ONLY
//This code is NOT intended to show best practices or ideal code
//Use at your most careful discretion

using System;
using System.Net;
using System.Drawing;
using System.Collections;
using System.ComponentModel;
using System.Windows.Forms;
using System.Data;
using System.IO;
using Interop.qbposfc4;

namespace com.intuit.idn.samples
{
        public class SampleEmployeeAdd
        {
                public void  DoEmployeeAdd()
                {
                        bool sessionBegun = false;
                        bool connectionOpen = false;
                        QBPOSSessionManager sessionManager = null;

                        try
                        {
                                //Create the session Manager object
                                sessionManager = new QBPOSSessionManager();

                                //Create the message set request object to hold our request
                                IMsgSetRequest requestMsgSet = sessionManager.CreateMsgSetRequest(4,0);
                                requestMsgSet.Attributes.OnError = ENRqOnError.roeContinue;

                                BuildEmployeeAddRq(requestMsgSet);

                                //Connect to QuickBooks and begin a session
                                sessionManager.OpenConnection("","Sample Code from OSR");
                                connectionOpen = true;
                                sessionManager.BeginSession("");
                                sessionBegun = true;

                                //Send the request and get the response from QuickBooks
                                IMsgSetResponse responseMsgSet = sessionManager.DoRequests(requestMsgSet);

                                //End the session and close the connection to QuickBooks
                                sessionManager.EndSession();
                                sessionBegun = false;
                                sessionManager.CloseConnection();
                                connectionOpen = false;

                                WalkEmployeeAddRs(responseMsgSet);
                        }
                        catch (Exception e)
                        {
                                MessageBox.Show(e.Message, "Error");
                                if (sessionBegun)
                                {
                                        sessionManager.EndSession();
                                }
                                if (connectionOpen)
                                {
                                        sessionManager.CloseConnection();
                                }
                        }
                }
                void BuildEmployeeAddRq(IMsgSetRequest requestMsgSet)
                {
                        IEmployeeAdd EmployeeAddRq= requestMsgSet.AppendEmployeeAddRq();
                        //Set attributes
                        //Set field value for defMacro
                        EmployeeAddRq.defMacro.SetValue("IQBStringType");
                        //Set field value for City
                        EmployeeAddRq.City.SetValue("ab");
                        //Set field value for CommissionPercent
                        EmployeeAddRq.CommissionPercent.SetValue(12.34F);
                        //Set field value for Country
                        EmployeeAddRq.Country.SetValue("ab");
                        //Set field value for EMail
                        EmployeeAddRq.EMail.SetValue("ab");
                        //Set field value for FirstName
                        EmployeeAddRq.FirstName.SetValue("ab");
                        //Set field value for IsTrackingHours
                        EmployeeAddRq.IsTrackingHours.SetValue(true);
                        //Set field value for LastName
                        EmployeeAddRq.LastName.SetValue("ab");
                        //Set field value for LoginName
                        EmployeeAddRq.LoginName.SetValue("ab");
                        //Set field value for Notes
                        EmployeeAddRq.Notes.SetValue("ab");
                        //Set field value for Phone
                        EmployeeAddRq.Phone.SetValue("ab");
                        //Set field value for Phone2
                        EmployeeAddRq.Phone2.SetValue("ab");
                        //Set field value for Phone3
                        EmployeeAddRq.Phone3.SetValue("ab");
                        //Set field value for Phone4
                        EmployeeAddRq.Phone4.SetValue("ab");
                        //Set field value for PostalCode
                        EmployeeAddRq.PostalCode.SetValue("ab");
                        //Set field value for State
                        EmployeeAddRq.State.SetValue("ab");
                        //Set field value for Street
                        EmployeeAddRq.Street.SetValue("ab");
                        //Set field value for Street2
                        EmployeeAddRq.Street2.SetValue("ab");
                        //Set field value for SecurityGroup
                        EmployeeAddRq.SecurityGroup.SetValue("ab");
                        //Set field value for IncludeRetElementList
                        //May create more than one of these if needed
                        EmployeeAddRq.IncludeRetElementList.Add("ab");
                }




                void WalkEmployeeAddRs(IMsgSetResponse responseMsgSet)
                {
                        if (responseMsgSet == null) return;
                        IResponseList responseList = responseMsgSet.ResponseList;
                        if (responseList == null) return;
                        //if we sent only one request, there is only one response, we'll walk the list for this sample
                        for(int i=0; i < responseList.Count; i++)
                        {
                                IResponse response = responseList.GetAt(i);
                                //check the status code of the response, 0=ok, >0 is warning
                                if (response.StatusCode >= 0)
                                {
                                        //the request-specific response is in the details, make sure we have some
                                        if (response.Detail != null)
                                        {
                                                //make sure the response is the type we're expecting
                                                ENResponseType responseType = (ENResponseType)response.Type.GetValue();
                                                if (responseType == ENResponseType.rtEmployeeAddRs)
                                                {
                                                        //upcast to more specific type here, this is safe because we checked with response.Type check above
                                                        IEmployeeRet EmployeeRet = (IEmployeeRet)response.Detail;
                                                                WalkEmployeeRet(EmployeeRet);
                                                }
                                        }
                                }
                        }
                }




                void WalkEmployeeRet(IEmployeeRet EmployeeRet)
                {
                        if (EmployeeRet == null) return;
                        //Go through all the elements of IEmployeeRet
                        //Get value of ListID
                        if (EmployeeRet.ListID != null)
                        {
                                string ListID723 = (string)EmployeeRet.ListID.GetValue();
                        }
                        //Get value of TimeCreated
                        if (EmployeeRet.TimeCreated != null)
                        {
                                DateTime TimeCreated724 = (DateTime)EmployeeRet.TimeCreated.GetValue();
                        }
                        //Get value of TimeModified
                        if (EmployeeRet.TimeModified != null)
                        {
                                DateTime TimeModified725 = (DateTime)EmployeeRet.TimeModified.GetValue();
                        }
                        //Get value of City
                        if (EmployeeRet.City != null)
                        {
                                string City726 = (string)EmployeeRet.City.GetValue();
                        }
                        //Get value of CommissionPercent
                        if (EmployeeRet.CommissionPercent != null)
                        {
                                float CommissionPercent727 = (float)EmployeeRet.CommissionPercent.GetValue();
                        }
                        //Get value of Country
                        if (EmployeeRet.Country != null)
                        {
                                string Country728 = (string)EmployeeRet.Country.GetValue();
                        }
                        //Get value of EMail
                        if (EmployeeRet.EMail != null)
                        {
                                string EMail729 = (string)EmployeeRet.EMail.GetValue();
                        }
                        //Get value of FirstName
                        if (EmployeeRet.FirstName != null)
                        {
                                string FirstName730 = (string)EmployeeRet.FirstName.GetValue();
                        }
                        //Get value of IsTrackingHours
                        if (EmployeeRet.IsTrackingHours != null)
                        {
                                bool IsTrackingHours731 = (bool)EmployeeRet.IsTrackingHours.GetValue();
                        }
                        //Get value of LastName
                        if (EmployeeRet.LastName != null)
                        {
                                string LastName732 = (string)EmployeeRet.LastName.GetValue();
                        }
                        //Get value of LoginName
                        if (EmployeeRet.LoginName != null)
                        {
                                string LoginName733 = (string)EmployeeRet.LoginName.GetValue();
                        }
                        //Get value of Notes
                        if (EmployeeRet.Notes != null)
                        {
                                string Notes734 = (string)EmployeeRet.Notes.GetValue();
                        }
                        //Get value of Phone
                        if (EmployeeRet.Phone != null)
                        {
                                string Phone735 = (string)EmployeeRet.Phone.GetValue();
                        }
                        //Get value of Phone2
                        if (EmployeeRet.Phone2 != null)
                        {
                                string Phone2736 = (string)EmployeeRet.Phone2.GetValue();
                        }
                        //Get value of Phone3
                        if (EmployeeRet.Phone3 != null)
                        {
                                string Phone3737 = (string)EmployeeRet.Phone3.GetValue();
                        }
                        //Get value of Phone4
                        if (EmployeeRet.Phone4 != null)
                        {
                                string Phone4738 = (string)EmployeeRet.Phone4.GetValue();
                        }
                        //Get value of PostalCode
                        if (EmployeeRet.PostalCode != null)
                        {
                                string PostalCode739 = (string)EmployeeRet.PostalCode.GetValue();
                        }
                        //Get value of State
                        if (EmployeeRet.State != null)
                        {
                                string State740 = (string)EmployeeRet.State.GetValue();
                        }
                        //Get value of Street
                        if (EmployeeRet.Street != null)
                        {
                                string Street741 = (string)EmployeeRet.Street.GetValue();
                        }
                        //Get value of Street2
                        if (EmployeeRet.Street2 != null)
                        {
                                string Street2742 = (string)EmployeeRet.Street2.GetValue();
                        }
                        //Get value of SecurityGroup
                        if (EmployeeRet.SecurityGroup != null)
                        {
                                string SecurityGroup743 = (string)EmployeeRet.SecurityGroup.GetValue();
                        }
                        if (EmployeeRet.DataExtRetList != null)
                        {
                                for (int i744 = 0; i744 < EmployeeRet.DataExtRetList.Count; i744++)
                                {
                                        IDataExtRet DataExtRet = EmployeeRet.DataExtRetList.GetAt(i744);
                                        //Get value of OwnerID
                                        string OwnerID745 = (string)DataExtRet.OwnerID.GetValue();
                                        //Get value of DataExtName
                                        string DataExtName746 = (string)DataExtRet.DataExtName.GetValue();
                                        //Get value of DataExtType
                                        ENDataExtType DataExtType747 = (ENDataExtType)DataExtRet.DataExtType.GetValue();
                                        //Get value of DataExtValue
                                        string DataExtValue748 = (string)DataExtRet.DataExtValue.GetValue();
                                }
                        }
                }




        }
}