ItemPaymentAdd

For an ItemPaymentAdd request, you can “set” the “Group with undeposited funds” radio button in QuickBooks either by not specifying DepositToAccountRef at all, or by specifying the special UndepositedFunds account for the DepositToAccountRef.


Request

Response

XMLOps

VB.NET

C#

Tag Type Max length Implementation Required

IItemPaymentAdd

For an ItemPaymentAdd request, you can “set” the “Group with undeposited funds” radio button in QuickBooks either by not specifying DepositToAccountRef at all, or by specifying the special UndepositedFunds account for the DepositToAccountRef.
        

Name

The case-insensitive name of a list object, not including the names of its ancestors. Name must be unique, unless it is the Name of a “hierarchical” list object. List objects in different hierarchies can have duplicate names because their FullNames will still be unique. For example, two objects could both have the Name kitchen, but they could have unique FullNames, such as Job12:kitchen and Baker:kitchen. For built-in currencies, Name is the internationally accepted currency name and is not editable.
 IQBStringType 31 chars   Y

BarCode

Barcode reference information.
 IBarCode   12.0  

BarCodeValue

Value of the barcode in the item.
 IQBStringType 50 chars    

AssignEvenIfUsed

Allow barcode to be assigned to item, even if already in use.
 IQBBoolType      

AllowOverride

Allows for barcode to be overridden for an item.
 IQBBoolType      

IsActive

If IsActive is true, this object is currently enabled for use by QuickBooks. The default value is true.
 IQBBoolType      

ClassRef

Classes can be used to separate transactions into meaningful categories. (For example, transactions could be classified according to department, business location, or type of work.) In QuickBooks, class tracking is off by default. A ClassRef aggregate refers to one of these named classes. For example, in a TimeTracking message, ClassRef refers to the QuickBooks class into which the timed activity falls. If a ClassRef aggregate includes both FullName and ListID, FullName will be ignored. In an InvoiceAdd request, if you specify a ClassRef for the whole invoice, that same ClassRef is automatically used in the line items. If you want to clear that (that is, have NO ClassRef for the line item, you can clear it in the line item by simply not specifying it in the line item.
 IQBBaseRef   12.0  

ListID

Along with FullName, ListID is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a ListID. A ListID is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same ListID, and a customer could not have the same ListID as an employee (because Customer and Employee are both name lists). But a customer could have the same ListID as a non-inventory item.
 IQBIDType   12.0  

FullName

FullName (along with ListID) is a way to identify a list object. The FullName is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. FullName values are not case-sensitive.
 IQBStringType 159 chars 12.0  

ItemDesc

The description that will appear on a sales form when the item is used.
 IQBStringType 4095 chars    

DepositToAccountRef

Refers to the account where these funds will be (or have been) deposited. In a ReceivePaymentAdd request, the default is Undeposited Funds if this is not included in the request. In a request, if a DepositToAccountRef aggregate includes both FullName and ListID, FullName will be ignored.
 IQBBaseRef      

ListID

Along with FullName, ListID is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a ListID. A ListID is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same ListID, and a customer could not have the same ListID as an employee (because Customer and Employee are both name lists). But a customer could have the same ListID as a non-inventory item.
 IQBIDType      

FullName

FullName (along with ListID) is a way to identify a list object. The FullName is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. FullName values are not case-sensitive.
 IQBStringType 159 chars    

PaymentMethodRef

A customer’s payment method, for example, cash, check, or Master Card. A PaymentMethodRef aggregate refers to an item on the PaymentMethod list. In a request, if a PaymentMethodRef aggregate includes both FullName and ListID, FullName will be ignored. In a SalesReceiptAdd, ReceivePaymentAdd, or ARRefundCreditCard request that contains credit card transaction data supplied from QBMS transaction responses, you must specify the payment method, and the payment method must be a credit card type.
 IQBBaseRef      

ListID

Along with FullName, ListID is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a ListID. A ListID is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same ListID, and a customer could not have the same ListID as an employee (because Customer and Employee are both name lists). But a customer could have the same ListID as a non-inventory item.
 IQBIDType      

FullName

FullName (along with ListID) is a way to identify a list object. The FullName is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. FullName values are not case-sensitive.
 IQBStringType 31 chars    

ExternalGUID

Allows for the attachment of a user defined GUID value.
 IQBGUIDType   8.0  

IncludeRetElementList

You use this if you want to limit the data that will be returned in the response. In this list, you specify the name of each top-level element or aggregate that you want to be returned in the response to the request. You cannot specify fields within an aggregate, for example, you cannot specify a City within an Address: you must specify Address and will get the entire address. The names specified in the list are not parsed, so you must be especially careful to supply valid names, properly cased. No error is returned in the status code if you specify an invalid name. Notice that if you want to return custom data or private data extensions, you must specify the DataExtRet element and you must supply the OwnerID set to either a value of 0 (custom data) or the GUID for the private data.
 IBSTRList 50 chars 4.0  
Tag Type Max length Implementation Required

IResponse

For an ItemPaymentAdd request, you can “set” the “Group with undeposited funds” radio button in QuickBooks either by not specifying DepositToAccountRef at all, or by specifying the special UndepositedFunds account for the DepositToAccountRef.
        

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

 IItemPaymentRet      

ListID

Along with FullName, ListID is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a ListID. A ListID is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same ListID, and a customer could not have the same ListID as an employee (because Customer and Employee are both name lists). But a customer could have the same ListID as a non-inventory item.
 IQBIDType     Y

TimeCreated

Time the object was created.
 IQBDateTimeType     Y

TimeModified

Time the object was last modified.
 IQBDateTimeType     Y

EditSequence

A number that the server generates and assigns to this object. Every time the object is changed, the server will change its EditSequence value. When you try to modify a list object, you must provide its EditSequence. The server compares the EditSequence you provide with the EditSequence in memory to make sure you are dealing with the latest copy of the object. If you are not, the server will reject the request and return an error. Because EditSequence is only used to check whether two objects match, there is no reason to interpret its value.
 IQBStringType 16 chars   Y

Name

The case-insensitive name of a list object, not including the names of its ancestors. Name must be unique, unless it is the Name of a “hierarchical” list object. List objects in different hierarchies can have duplicate names because their FullNames will still be unique. For example, two objects could both have the Name kitchen, but they could have unique FullNames, such as Job12:kitchen and Baker:kitchen. For built-in currencies, Name is the internationally accepted currency name and is not editable.
 IQBStringType 31 chars   Y

BarCodeValue

Value of the barcode in the item.
 IQBStringType 50 chars 12.0  

IsActive

If IsActive is true, this object is currently enabled for use by QuickBooks. The default value is true.
 IQBBoolType      

ClassRef

Classes can be used to separate transactions into meaningful categories. (For example, transactions could be classified according to department, business location, or type of work.) In QuickBooks, class tracking is off by default. A ClassRef aggregate refers to one of these named classes. For example, in a TimeTracking message, ClassRef refers to the QuickBooks class into which the timed activity falls. If a ClassRef aggregate includes both FullName and ListID, FullName will be ignored. In an InvoiceAdd request, if you specify a ClassRef for the whole invoice, that same ClassRef is automatically used in the line items. If you want to clear that (that is, have NO ClassRef for the line item, you can clear it in the line item by simply not specifying it in the line item.
 IQBBaseRef   12.0  

ListID

Along with FullName, ListID is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a ListID. A ListID is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same ListID, and a customer could not have the same ListID as an employee (because Customer and Employee are both name lists). But a customer could have the same ListID as a non-inventory item.
 IQBIDType   12.0  

FullName

FullName (along with ListID) is a way to identify a list object. The FullName is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. FullName values are not case-sensitive.
 IQBStringType 159 chars 12.0  

ItemDesc

The description that will appear on a sales form when the item is used.
 IQBStringType 4095 chars    

DepositToAccountRef

Refers to the account where these funds will be (or have been) deposited. In a ReceivePaymentAdd request, the default is Undeposited Funds if this is not included in the request. In a request, if a DepositToAccountRef aggregate includes both FullName and ListID, FullName will be ignored.
 IQBBaseRef      

ListID

Along with FullName, ListID is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a ListID. A ListID is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same ListID, and a customer could not have the same ListID as an employee (because Customer and Employee are both name lists). But a customer could have the same ListID as a non-inventory item.
 IQBIDType      

FullName

FullName (along with ListID) is a way to identify a list object. The FullName is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. FullName values are not case-sensitive.
 IQBStringType 159 chars    

PaymentMethodRef

A customer’s payment method, for example, cash, check, or Master Card. A PaymentMethodRef aggregate refers to an item on the PaymentMethod list. In a request, if a PaymentMethodRef aggregate includes both FullName and ListID, FullName will be ignored. In a SalesReceiptAdd, ReceivePaymentAdd, or ARRefundCreditCard request that contains credit card transaction data supplied from QBMS transaction responses, you must specify the payment method, and the payment method must be a credit card type.
 IQBBaseRef      

ListID

Along with FullName, ListID is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a ListID. A ListID is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same ListID, and a customer could not have the same ListID as an employee (because Customer and Employee are both name lists). But a customer could have the same ListID as a non-inventory item.
 IQBIDType      

FullName

FullName (along with ListID) is a way to identify a list object. The FullName is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. FullName values are not case-sensitive.
 IQBStringType 31 chars    

ExternalGUID

Allows for the attachment of a user defined GUID value.
 IQBGUIDType   8.0  

DataExtRetList

A list of IDataExtRet objects, each of which represents a field that has been added to QuickBooks as a data extension.
 IDataExtRetList   2.0  

(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      

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 31 chars   Y

DataExtType

The field’s data type, which corresponds to a qbXML data type. In an IDataExtDefAdd request object, if this is a custom field, DataExtType must be detSTR255TYPE.
 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

Detail

 IErrorRecovery   11.0  

ORListOwnerTxn

 IORListOwnerTxn     Y

ListID

Along with FullName, ListID is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a ListID. A ListID is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same ListID, and a customer could not have the same ListID as an employee (because Customer and Employee are both name lists). But a customer could have the same ListID as a non-inventory item.
 IQBIDType      

OwnerID

Refers to the owner of a data extension:If OwnerID is 0, this is a public data extension, also known as a custom field. Custom fields appear in the QuickBooks UI.If OwnerID is a GUID, for example {6B063959-81B0-4622-85D6-F548C8CCB517}, this field is a private data extension defined by an integrated application. Private data extensions do not appear in the QuickBooks UI. Note that OwnerID values are not case-sensitive, meaning that if you enter an OwnerID value with lower-case letters, the value will be saved and returned with upper-case letters. When you share a private 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      

TxnID

QuickBooks generates a unique TxnID for each transaction that is added to QuickBooks. A TxnID returned from a request can be used to refer to the transaction in subsequent requests. Notice that you cannot supply the TxnID of a TimeTracking transaction to TransactionQueryRq requests. If you do, you get an error stating that no such record could be found, even though the transaction is in QuickBooks. This behavior reflects the behavior in the QuicKBooks UI in the Find window.
 IQBIDType      

TxnNumber

An identifying number for this transaction.
 IQBIntType      

EditSequence

A number that the server generates and assigns to this object. Every time the object is changed, the server will change its EditSequence value. When you try to modify a list object, you must provide its EditSequence. The server compares the EditSequence you provide with the EditSequence in memory to make sure you are dealing with the latest copy of the object. If you are not, the server will reject the request and return an error. Because EditSequence is only used to check whether two objects match, there is no reason to interpret its value.
 IQBStringType 16 chars    

ExternalGUID

Allows for the attachment of a user defined GUID value.
 IQBGUIDType       

 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
<?xml version="1.0" encoding="utf-8"?>
<?qbxml version="17.0"?>
<QBXML>
        <QBXMLMsgsRq onError="stopOnError">
                <ItemPaymentAddRq>
                        <ItemPaymentAdd> <!-- required -->
                                <Name >STRTYPE</Name> <!-- required -->
                                <BarCode> <!-- optional -->
                                        <BarCodeValue >STRTYPE</BarCodeValue> <!-- optional -->
                                        <AssignEvenIfUsed >BOOLTYPE</AssignEvenIfUsed> <!-- optional -->
                                        <AllowOverride >BOOLTYPE</AllowOverride> <!-- optional -->
                                </BarCode>
                                <IsActive >BOOLTYPE</IsActive> <!-- optional -->
                                <ClassRef> <!-- optional -->
                                        <ListID >IDTYPE</ListID> <!-- optional -->
                                        <FullName >STRTYPE</FullName> <!-- optional -->
                                </ClassRef>
                                <ItemDesc >STRTYPE</ItemDesc> <!-- optional -->
                                <DepositToAccountRef> <!-- optional -->
                                        <ListID >IDTYPE</ListID> <!-- optional -->
                                        <FullName >STRTYPE</FullName> <!-- optional -->
                                </DepositToAccountRef>
                                <PaymentMethodRef> <!-- optional -->
                                        <ListID >IDTYPE</ListID> <!-- optional -->
                                        <FullName >STRTYPE</FullName> <!-- optional -->
                                </PaymentMethodRef>
                                <ExternalGUID >GUIDTYPE</ExternalGUID> <!-- optional -->
                        </ItemPaymentAdd>
                        <IncludeRetElement >STRTYPE</IncludeRetElement> <!-- optional, may repeat -->
                </ItemPaymentAddRq>

                <ItemPaymentAddRs statusCode="INTTYPE" statusSeverity="STRTYPE" statusMessage="STRTYPE">
                        <ItemPaymentRet> <!-- optional -->
                                <ListID >IDTYPE</ListID> <!-- required -->
                                <TimeCreated >DATETIMETYPE</TimeCreated> <!-- required -->
                                <TimeModified >DATETIMETYPE</TimeModified> <!-- required -->
                                <EditSequence >STRTYPE</EditSequence> <!-- required -->
                                <Name >STRTYPE</Name> <!-- required -->
                                <BarCodeValue >STRTYPE</BarCodeValue> <!-- optional -->
                                <IsActive >BOOLTYPE</IsActive> <!-- optional -->
                                <ClassRef> <!-- optional -->
                                        <ListID >IDTYPE</ListID> <!-- optional -->
                                        <FullName >STRTYPE</FullName> <!-- optional -->
                                </ClassRef>
                                <ItemDesc >STRTYPE</ItemDesc> <!-- optional -->
                                <DepositToAccountRef> <!-- optional -->
                                        <ListID >IDTYPE</ListID> <!-- optional -->
                                        <FullName >STRTYPE</FullName> <!-- optional -->
                                </DepositToAccountRef>
                                <PaymentMethodRef> <!-- optional -->
                                        <ListID >IDTYPE</ListID> <!-- optional -->
                                        <FullName >STRTYPE</FullName> <!-- optional -->
                                </PaymentMethodRef>
                                <ExternalGUID >GUIDTYPE</ExternalGUID> <!-- optional -->
                                <DataExtRet> <!-- optional, may repeat -->
                                        <OwnerID >GUIDTYPE</OwnerID> <!-- optional -->
                                        <DataExtName >STRTYPE</DataExtName> <!-- required -->
                                        <!-- DataExtType may have one of the following values: AMTTYPE, DATETIMETYPE, INTTYPE, PERCENTTYPE, PRICETYPE, QUANTYPE, STR1024TYPE, STR255TYPE -->
                                        <DataExtType >ENUMTYPE</DataExtType> <!-- required -->
                                        <DataExtValue >STRTYPE</DataExtValue> <!-- required -->
                                </DataExtRet>
                        </ItemPaymentRet>
                        <ErrorRecovery> <!-- optional -->
                                <!-- BEGIN OR -->
                                        <ListID >IDTYPE</ListID> <!-- optional -->
                                <!-- OR -->
                                        <OwnerID >GUIDTYPE</OwnerID> <!-- optional -->
                                <!-- OR -->
                                        <TxnID >IDTYPE</TxnID> <!-- optional -->
                                <!-- END OR -->
                                <TxnNumber >INTTYPE</TxnNumber> <!-- optional -->
                                <EditSequence >STRTYPE</EditSequence> <!-- optional -->
                                <ExternalGUID >GUIDTYPE</ExternalGUID> <!-- optional -->
                        </ErrorRecovery>
                </ItemPaymentAddRs>
        </QBXMLMsgsRq>
</QBXML>


  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
'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.QBFC16

Module com.intuit.idn.samples
        Public Class Sample
                Public Sub  DoItemPaymentAdd()
                        Dim sessionBegun as Boolean
                        sessionBegun = False
                        Dim connectionOpen as Boolean
                        connectionOpen = False
                        Dim sessionManager as QBSessionManager
                        sessionManager = nothing

                        Try
                                'Create the session Manager object
                                sessionManager = new QBSessionManager

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

                                BuildItemPaymentAddRq(requestMsgSet)

                                'Connect to QuickBooks and begin a session
                                sessionManager.OpenConnection("","Sample Code from OSR")
                                connectionOpen = True
                                sessionManager.BeginSession("", ENOpenMode.omDontCare)
                                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

                                WalkItemPaymentAddRs(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 BuildItemPaymentAddRq(requestMsgSet as IMsgSetRequest)
                        Dim ItemPaymentAddRq as IItemPaymentAdd
                        ItemPaymentAddRq= requestMsgSet.AppendItemPaymentAddRq()
                        'Set field value for Name
                        ItemPaymentAddRq.Name.SetValue("ab")
                        'Set field value for BarCodeValue
                        ItemPaymentAddRq.BarCode.BarCodeValue.SetValue("ab")
                        'Set field value for AssignEvenIfUsed
                        ItemPaymentAddRq.BarCode.AssignEvenIfUsed.SetValue(True)
                        'Set field value for AllowOverride
                        ItemPaymentAddRq.BarCode.AllowOverride.SetValue(True)
                        'Set field value for IsActive
                        ItemPaymentAddRq.IsActive.SetValue(True)
                        'Set field value for ListID
                        ItemPaymentAddRq.ClassRef.ListID.SetValue("200000-1011023419")
                        'Set field value for FullName
                        ItemPaymentAddRq.ClassRef.FullName.SetValue("ab")
                        'Set field value for ItemDesc
                        ItemPaymentAddRq.ItemDesc.SetValue("ab")
                        'Set field value for ListID
                        ItemPaymentAddRq.DepositToAccountRef.ListID.SetValue("200000-1011023419")
                        'Set field value for FullName
                        ItemPaymentAddRq.DepositToAccountRef.FullName.SetValue("ab")
                        'Set field value for ListID
                        ItemPaymentAddRq.PaymentMethodRef.ListID.SetValue("200000-1011023419")
                        'Set field value for FullName
                        ItemPaymentAddRq.PaymentMethodRef.FullName.SetValue("ab")
                        'Set field value for ExternalGUID
                        ItemPaymentAddRq.ExternalGUID.SetValue(System.Guid.NewGuid().ToString())
                        'Set field value for IncludeRetElementList
                        'May create more than one of these if needed
                        ItemPaymentAddRq.IncludeRetElementList.Add("ab")
                End Sub




                Public Sub WalkItemPaymentAddRs( 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.rtItemPaymentAddRs) then
                                                        'upcast to more specific type here, this is safe because we checked with response.Type check above
                                                        Dim ItemPaymentRet as IItemPaymentRet
                                                        ItemPaymentRet = CType(response.Detail,IItemPaymentRet)
                                                        WalkItemPaymentRet(ItemPaymentRet)
                                                End If
                                        End If
                                End If
                        Next j
                End Sub




                Public Sub WalkItemPaymentRet(ItemPaymentRet as IItemPaymentRet)
                        if (ItemPaymentRet is nothing) then
                                Exit Sub
                        End If

                        'Go through all the elements of IItemPaymentRet
                        'Get value of ListID
                        Dim ListID13933 as String
                        ListID13933 = ItemPaymentRet.ListID.GetValue()
                        'Get value of TimeCreated
                        Dim TimeCreated13934 as DateTime
                        TimeCreated13934 = ItemPaymentRet.TimeCreated.GetValue()
                        'Get value of TimeModified
                        Dim TimeModified13935 as DateTime
                        TimeModified13935 = ItemPaymentRet.TimeModified.GetValue()
                        'Get value of EditSequence
                        Dim EditSequence13936 as String
                        EditSequence13936 = ItemPaymentRet.EditSequence.GetValue()
                        'Get value of Name
                        Dim Name13937 as String
                        Name13937 = ItemPaymentRet.Name.GetValue()
                        'Get value of BarCodeValue
                        if ( not ItemPaymentRet.BarCodeValue is nothing) then
                                Dim BarCodeValue13938 as String
                                BarCodeValue13938 = ItemPaymentRet.BarCodeValue.GetValue()
                        End If
                        'Get value of IsActive
                        if ( not ItemPaymentRet.IsActive is nothing) then
                                Dim IsActive13939 as Boolean
                                IsActive13939 = ItemPaymentRet.IsActive.GetValue()
                        End If
                        if (not ItemPaymentRet.ClassRef. is nothing) then
                                'Get value of ListID
                                if ( not ItemPaymentRet.ClassRef.ListID is nothing) then
                                        Dim ListID13940 as String
                                        ListID13940 = ItemPaymentRet.ClassRef.ListID.GetValue()
                                End If
                                'Get value of FullName
                                if ( not ItemPaymentRet.ClassRef.FullName is nothing) then
                                        Dim FullName13941 as String
                                        FullName13941 = ItemPaymentRet.ClassRef.FullName.GetValue()
                                End If
                        End If
                        'Get value of ItemDesc
                        if ( not ItemPaymentRet.ItemDesc is nothing) then
                                Dim ItemDesc13942 as String
                                ItemDesc13942 = ItemPaymentRet.ItemDesc.GetValue()
                        End If
                        if (not ItemPaymentRet.DepositToAccountRef. is nothing) then
                                'Get value of ListID
                                if ( not ItemPaymentRet.DepositToAccountRef.ListID is nothing) then
                                        Dim ListID13943 as String
                                        ListID13943 = ItemPaymentRet.DepositToAccountRef.ListID.GetValue()
                                End If
                                'Get value of FullName
                                if ( not ItemPaymentRet.DepositToAccountRef.FullName is nothing) then
                                        Dim FullName13944 as String
                                        FullName13944 = ItemPaymentRet.DepositToAccountRef.FullName.GetValue()
                                End If
                        End If
                        if (not ItemPaymentRet.PaymentMethodRef. is nothing) then
                                'Get value of ListID
                                if ( not ItemPaymentRet.PaymentMethodRef.ListID is nothing) then
                                        Dim ListID13945 as String
                                        ListID13945 = ItemPaymentRet.PaymentMethodRef.ListID.GetValue()
                                End If
                                'Get value of FullName
                                if ( not ItemPaymentRet.PaymentMethodRef.FullName is nothing) then
                                        Dim FullName13946 as String
                                        FullName13946 = ItemPaymentRet.PaymentMethodRef.FullName.GetValue()
                                End If
                        End If
                        'Get value of ExternalGUID
                        if ( not ItemPaymentRet.ExternalGUID is nothing) then
                                Dim ExternalGUID13947 as String
                                ExternalGUID13947 = ItemPaymentRet.ExternalGUID.GetValue()
                        End If
                        if (not ItemPaymentRet.DataExtRetList is nothing)
                                Dim i13948 as Integer
                                for i13948 = 0  to ItemPaymentRet.DataExtRetList.Count - 1
                                        Dim DataExtRet as IDataExtRet
                                        DataExtRet = ItemPaymentRet.DataExtRetList.GetAt(i13948)
                                        'Get value of OwnerID
                                        if ( not DataExtRetOwnerID is nothing) then
                                                Dim OwnerID13949 as String
                                                OwnerID13949 = DataExtRetOwnerID.GetValue()
                                        End If
                                        'Get value of DataExtName
                                        Dim DataExtName13950 as String
                                        DataExtName13950 = DataExtRetDataExtName.GetValue()
                                        'Get value of DataExtType
                                        Dim DataExtType13951 as ENDataExtType
                                        DataExtType13951 = DataExtRetDataExtType.GetValue()
                                        'Get value of DataExtValue
                                        Dim DataExtValue13952 as String
                                        DataExtValue13952 = DataExtRetDataExtValue.GetValue()
                                Next i13948
                        End If
                End Sub




        End Class
End Module


  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
//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.QBFC16;

namespace com.intuit.idn.samples
{
        public class Sample
        {
                public void  DoItemPaymentAdd()
                {
                        bool sessionBegun = false;
                        bool connectionOpen = false;
                        QBSessionManager sessionManager = null;

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

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

                                BuildItemPaymentAddRq(requestMsgSet);

                                //Connect to QuickBooks and begin a session
                                sessionManager.OpenConnection("","Sample Code from OSR");
                                connectionOpen = true;
                                sessionManager.BeginSession("", ENOpenMode.omDontCare);
                                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;

                                WalkItemPaymentAddRs(responseMsgSet);
                        }
                        catch (Exception e)
                        {
                                MessageBox.Show(e.Message, "Error");
                                if (sessionBegun)
                                {
                                        sessionManager.EndSession();
                                }
                                if (connectionOpen)
                                {
                                        sessionManager.CloseConnection();
                                }
                        }
                }
                void BuildItemPaymentAddRq(IMsgSetRequest requestMsgSet)
                {
                        IItemPaymentAdd ItemPaymentAddRq= requestMsgSet.AppendItemPaymentAddRq();
                        //Set field value for Name
                        ItemPaymentAddRq.Name.SetValue("ab");
                        //Set field value for BarCodeValue
                        ItemPaymentAddRq.BarCode.BarCodeValue.SetValue("ab");
                        //Set field value for AssignEvenIfUsed
                        ItemPaymentAddRq.BarCode.AssignEvenIfUsed.SetValue(true);
                        //Set field value for AllowOverride
                        ItemPaymentAddRq.BarCode.AllowOverride.SetValue(true);
                        //Set field value for IsActive
                        ItemPaymentAddRq.IsActive.SetValue(true);
                        //Set field value for ListID
                        ItemPaymentAddRq.ClassRef.ListID.SetValue("200000-1011023419");
                        //Set field value for FullName
                        ItemPaymentAddRq.ClassRef.FullName.SetValue("ab");
                        //Set field value for ItemDesc
                        ItemPaymentAddRq.ItemDesc.SetValue("ab");
                        //Set field value for ListID
                        ItemPaymentAddRq.DepositToAccountRef.ListID.SetValue("200000-1011023419");
                        //Set field value for FullName
                        ItemPaymentAddRq.DepositToAccountRef.FullName.SetValue("ab");
                        //Set field value for ListID
                        ItemPaymentAddRq.PaymentMethodRef.ListID.SetValue("200000-1011023419");
                        //Set field value for FullName
                        ItemPaymentAddRq.PaymentMethodRef.FullName.SetValue("ab");
                        //Set field value for ExternalGUID
                        ItemPaymentAddRq.ExternalGUID.SetValue(Guid.NewGuid().ToString());
                        //Set field value for IncludeRetElementList
                        //May create more than one of these if needed
                        ItemPaymentAddRq.IncludeRetElementList.Add("ab");
                }




                void WalkItemPaymentAddRs(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.rtItemPaymentAddRs)
                                                {
                                                        //upcast to more specific type here, this is safe because we checked with response.Type check above
                                                        IItemPaymentRet ItemPaymentRet = (IItemPaymentRet)response.Detail;
                                                        WalkItemPaymentRet(ItemPaymentRet);
                                                }
                                        }
                                }
                        }
                }




                void WalkItemPaymentRet(IItemPaymentRet ItemPaymentRet)
                {
                        if (ItemPaymentRet == null) return;
                        //Go through all the elements of IItemPaymentRet
                        //Get value of ListID
                        string ListID13913 = (string)ItemPaymentRet.ListID.GetValue();
                        //Get value of TimeCreated
                        DateTime TimeCreated13914 = (DateTime)ItemPaymentRet.TimeCreated.GetValue();
                        //Get value of TimeModified
                        DateTime TimeModified13915 = (DateTime)ItemPaymentRet.TimeModified.GetValue();
                        //Get value of EditSequence
                        string EditSequence13916 = (string)ItemPaymentRet.EditSequence.GetValue();
                        //Get value of Name
                        string Name13917 = (string)ItemPaymentRet.Name.GetValue();
                        //Get value of BarCodeValue
                        if (ItemPaymentRet.BarCodeValue != null)
                        {
                                string BarCodeValue13918 = (string)ItemPaymentRet.BarCodeValue.GetValue();
                        }
                        //Get value of IsActive
                        if (ItemPaymentRet.IsActive != null)
                        {
                                bool IsActive13919 = (bool)ItemPaymentRet.IsActive.GetValue();
                        }
                        if (ItemPaymentRet.ClassRef != null)
                        {
                                //Get value of ListID
                                if (ItemPaymentRet.ClassRef.ListID != null)
                                {
                                        string ListID13920 = (string)ItemPaymentRet.ClassRef.ListID.GetValue();
                                }
                                //Get value of FullName
                                if (ItemPaymentRet.ClassRef.FullName != null)
                                {
                                        string FullName13921 = (string)ItemPaymentRet.ClassRef.FullName.GetValue();
                                }
                        }
                        //Get value of ItemDesc
                        if (ItemPaymentRet.ItemDesc != null)
                        {
                                string ItemDesc13922 = (string)ItemPaymentRet.ItemDesc.GetValue();
                        }
                        if (ItemPaymentRet.DepositToAccountRef != null)
                        {
                                //Get value of ListID
                                if (ItemPaymentRet.DepositToAccountRef.ListID != null)
                                {
                                        string ListID13923 = (string)ItemPaymentRet.DepositToAccountRef.ListID.GetValue();
                                }
                                //Get value of FullName
                                if (ItemPaymentRet.DepositToAccountRef.FullName != null)
                                {
                                        string FullName13924 = (string)ItemPaymentRet.DepositToAccountRef.FullName.GetValue();
                                }
                        }
                        if (ItemPaymentRet.PaymentMethodRef != null)
                        {
                                //Get value of ListID
                                if (ItemPaymentRet.PaymentMethodRef.ListID != null)
                                {
                                        string ListID13925 = (string)ItemPaymentRet.PaymentMethodRef.ListID.GetValue();
                                }
                                //Get value of FullName
                                if (ItemPaymentRet.PaymentMethodRef.FullName != null)
                                {
                                        string FullName13926 = (string)ItemPaymentRet.PaymentMethodRef.FullName.GetValue();
                                }
                        }
                        //Get value of ExternalGUID
                        if (ItemPaymentRet.ExternalGUID != null)
                        {
                                string ExternalGUID13927 = (string)ItemPaymentRet.ExternalGUID.GetValue();
                        }
                        if (ItemPaymentRet.DataExtRetList != null)
                        {
                                for (int i13928 = 0; i13928 < ItemPaymentRet.DataExtRetList.Count; i13928++)
                                {
                                        IDataExtRet DataExtRet = ItemPaymentRet.DataExtRetList.GetAt(i13928);
                                        //Get value of OwnerID
                                        if (DataExtRet.OwnerID != null)
                                        {
                                                string OwnerID13929 = (string)DataExtRet.OwnerID.GetValue();
                                        }
                                        //Get value of DataExtName
                                        string DataExtName13930 = (string)DataExtRet.DataExtName.GetValue();
                                        //Get value of DataExtType
                                        ENDataExtType DataExtType13931 = (ENDataExtType)DataExtRet.DataExtType.GetValue();
                                        //Get value of DataExtValue
                                        string DataExtValue13932 = (string)DataExtRet.DataExtValue.GetValue();
                                }
                        }
                }




        }
}