SalesTaxCodeAdd

Adds a sales tax code. Each item on a sales form is assigned a sales-tax code that indicates whether the item is taxable or non-taxable, and why. Two general codes, which can be modified but not deleted, appear on the sales-tax code list by default:
A sales-tax code can be deleted only if it is no longer associated with any customer, item, or transaction. If the “Do You Charge Sales Tax?” preference within QuickBooks is set to No, QuickBooks will assign the default non-taxable sales-tax code to all sales.
A SalesTaxCodeRef aggregate refers to a sales-tax code on the list. In a request, if a SalesTaxCodeRef aggregate includes both FullName and ListID, FullName will be ignored. In a Customer message, SalesTaxCodeRef refers to the sales-tax code that will be used for items related to this customer. In an ItemInventory message, SalesTaxCodeRef refers to the type of sales tax that will be charged for this item, if it is a taxable item and if sales tax is set up within QuickBooks.

Request

Response

XMLOps

VB.NET

C#

Tag Type Max length Implementation Required

ISalesTaxCodeAdd

Adds a sales tax code. Each item on a sales form is assigned a sales-tax code that indicates whether the item is taxable or non-taxable, and why. Two general codes, which can be modified but not deleted, appear on the sales-tax code list by default:Non-taxable (Name = NON; Desc = Non-Taxable; IsTaxable = false)Taxable (Name = TAX; Desc = Taxable; IsTaxable = true) A sales-tax code can be deleted only if it is no longer associated with any customer, item, or transaction. If the “Do You Charge Sales Tax?” preference within QuickBooks is set to No, QuickBooks will assign the default non-taxable sales-tax code to all sales. A SalesTaxCodeRef aggregate refers to a sales-tax code on the list. In a request, if a SalesTaxCodeRef aggregate includes both FullName and ListID, FullName will be ignored. In a Customer message, SalesTaxCodeRef refers to the sales-tax code that will be used for items related to this customer. In an ItemInventory message, SalesTaxCodeRef refers to the type of sales tax that will be charged for this item, if it is a taxable item and if sales tax is set up within QuickBooks.
       

Name

Short name that will appear on sales forms to identify the tax status of an item. The Desc element gives a longer explanation of Name. Name must be unique, and it is not case-sensitive.
IQBStringType 3 chars   Y

IsActive

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

IsTaxable

Indicates whether this sales-tax code is tracking taxable sales. For any particular sales-tax code, IsTaxable cannot be modified once the sales-tax code has been used in a transaction. If the “Do You Charge Sales Tax?” preference is set to Yes within QuickBooks, the default value of IsTaxable is true. If the “Do You Charge Sales Tax?” preference is set to No, the default value of IsTaxable is false.
IQBBoolType     Y

Desc

Desc gives a longer explanation of Name.
IQBStringType 31 chars    

ItemPurchaseTaxRef

For future use with international versions of QuickBooks.
IQBBaseRef   6.0 CA.png uk.png  

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   6.0 CA.png uk.png  

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 6.0 CA.png uk.png  

ItemSalesTaxRef

A sales-tax item is used to calculate a single sales tax that is collected at a specified rate and paid to a single agency. (Compare with the ItemSalesTaxGroupAdd message.) An ItemSalesTaxRef aggregate refers to an item on this list. In a request, if an ItemSalesTaxRef aggregate includes both FullName and ListID, FullName will be ignored. Taxes can be reflected in transaction line items The following information refers to invoices specifically, but it also applies to sales receipts. Generally its best to assign a tax item or tax group item to an invoice and allow QuickBooks to apply the same tax to all taxable items on the invoice. However in some situations multiple tax combinations are required, so this method doesn’t work. In this case one must use techniques to apply the taxes in the invoice itself as line items. Using lines to apply taxes isn’t always straight forward. When applying taxes as line items, only single tax items can be used, tax groups can only be used for the entire invoice. If you have multiple taxes which apply to all taxable items, and one or more other taxes that only apply to some of the items on an invoice its better to use a tax group which applies to the entire invoice for the taxes which applies to all taxable items and then apply the other taxes in the invoice itself. One applies a tax or tax group to an entire invoice by using the ItemSalesTaxRef aggregate. One can use subtotals to apply a single tax line to multiple items in an invoice, but the tax is only applied automatically for the first tax line after the subtotal line. Any other tax lines which need to be applied to the subtotal line must supply their own amount. If you don’t supply an amount the amount comes out as zero and the tax line is useless. When one does supply an amount, the amount of tax on the subtotal also shows up in the rate column for that tax line. There isn’t any way for the rate to show up as anything other than the amount of the tax. If you have a complicated tax situation where no single tax applies to all taxable items on the invoice, you must choose a zero percent tax to apply for the entire invoice. It is recommended to name such a tax item “Tax Calculated On Invoice” so that it’s clear that the tax is not being applied by QuickBooks on the entire invoice.
IQBBaseRef   6.0 CA.png uk.png  

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   6.0 CA.png uk.png  

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 6.0 CA.png uk.png  

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

Adds a sales tax code. Each item on a sales form is assigned a sales-tax code that indicates whether the item is taxable or non-taxable, and why. Two general codes, which can be modified but not deleted, appear on the sales-tax code list by default:Non-taxable (Name = NON; Desc = Non-Taxable; IsTaxable = false)Taxable (Name = TAX; Desc = Taxable; IsTaxable = true) A sales-tax code can be deleted only if it is no longer associated with any customer, item, or transaction. If the “Do You Charge Sales Tax?” preference within QuickBooks is set to No, QuickBooks will assign the default non-taxable sales-tax code to all sales. A SalesTaxCodeRef aggregate refers to a sales-tax code on the list. In a request, if a SalesTaxCodeRef aggregate includes both FullName and ListID, FullName will be ignored. In a Customer message, SalesTaxCodeRef refers to the sales-tax code that will be used for items related to this customer. In an ItemInventory message, SalesTaxCodeRef refers to the type of sales tax that will be charged for this item, if it is a taxable item and if sales tax is set up within QuickBooks.
       

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

ISalesTaxCodeRet      

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

Short name that will appear on sales forms to identify the tax status of an item. The Desc element gives a longer explanation of Name. Name must be unique, and it is not case-sensitive.
IQBStringType 3 chars   Y

IsActive

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

IsTaxable

Indicates whether this sales-tax code is tracking taxable sales. For any particular sales-tax code, IsTaxable cannot be modified once the sales-tax code has been used in a transaction. If the “Do You Charge Sales Tax?” preference is set to Yes within QuickBooks, the default value of IsTaxable is true. If the “Do You Charge Sales Tax?” preference is set to No, the default value of IsTaxable is false.
IQBBoolType     Y

Desc

Desc gives a longer explanation of Name.
IQBStringType 31 chars    

ItemPurchaseTaxRef

For future use with international versions of QuickBooks.
IQBBaseRef   6.0 CA.png uk.png  

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   6.0 CA.png uk.png  

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 6.0 CA.png uk.png  

ItemSalesTaxRef

A sales-tax item is used to calculate a single sales tax that is collected at a specified rate and paid to a single agency. (Compare with the ItemSalesTaxGroupAdd message.) An ItemSalesTaxRef aggregate refers to an item on this list. In a request, if an ItemSalesTaxRef aggregate includes both FullName and ListID, FullName will be ignored. Taxes can be reflected in transaction line items The following information refers to invoices specifically, but it also applies to sales receipts. Generally its best to assign a tax item or tax group item to an invoice and allow QuickBooks to apply the same tax to all taxable items on the invoice. However in some situations multiple tax combinations are required, so this method doesn’t work. In this case one must use techniques to apply the taxes in the invoice itself as line items. Using lines to apply taxes isn’t always straight forward. When applying taxes as line items, only single tax items can be used, tax groups can only be used for the entire invoice. If you have multiple taxes which apply to all taxable items, and one or more other taxes that only apply to some of the items on an invoice its better to use a tax group which applies to the entire invoice for the taxes which applies to all taxable items and then apply the other taxes in the invoice itself. One applies a tax or tax group to an entire invoice by using the ItemSalesTaxRef aggregate. One can use subtotals to apply a single tax line to multiple items in an invoice, but the tax is only applied automatically for the first tax line after the subtotal line. Any other tax lines which need to be applied to the subtotal line must supply their own amount. If you don’t supply an amount the amount comes out as zero and the tax line is useless. When one does supply an amount, the amount of tax on the subtotal also shows up in the rate column for that tax line. There isn’t any way for the rate to show up as anything other than the amount of the tax. If you have a complicated tax situation where no single tax applies to all taxable items on the invoice, you must choose a zero percent tax to apply for the entire invoice. It is recommended to name such a tax item “Tax Calculated On Invoice” so that it’s clear that the tax is not being applied by QuickBooks on the entire invoice.
IQBBaseRef   6.0 CA.png uk.png  

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   6.0 CA.png uk.png  

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 6.0 CA.png uk.png  

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
<?xml version="1.0" encoding="utf-8"?>
<?qbxml version="16.0"?>
<QBXML>
        <QBXMLMsgsRq onError="stopOnError">
                <SalesTaxCodeAddRq>
                        <SalesTaxCodeAdd> <!-- required -->
                                <Name >STRTYPE</Name> <!-- required -->
                                <IsActive >BOOLTYPE</IsActive> <!-- optional -->
                                <IsTaxable >BOOLTYPE</IsTaxable> <!-- required -->
                                <Desc >STRTYPE</Desc> <!-- optional -->
                                <ItemPurchaseTaxRef> <!-- optional -->
                                        <ListID >IDTYPE</ListID> <!-- optional -->
                                        <FullName >STRTYPE</FullName> <!-- optional -->
                                </ItemPurchaseTaxRef>
                                <ItemSalesTaxRef> <!-- optional -->
                                        <ListID >IDTYPE</ListID> <!-- optional -->
                                        <FullName >STRTYPE</FullName> <!-- optional -->
                                </ItemSalesTaxRef>
                        </SalesTaxCodeAdd>
                        <IncludeRetElement >STRTYPE</IncludeRetElement> <!-- optional, may repeat -->
                </SalesTaxCodeAddRq>

                <SalesTaxCodeAddRs statusCode="INTTYPE" statusSeverity="STRTYPE" statusMessage="STRTYPE">
                        <SalesTaxCodeRet> <!-- optional -->
                                <ListID >IDTYPE</ListID> <!-- required -->
                                <TimeCreated >DATETIMETYPE</TimeCreated> <!-- required -->
                                <TimeModified >DATETIMETYPE</TimeModified> <!-- required -->
                                <EditSequence >STRTYPE</EditSequence> <!-- required -->
                                <Name >STRTYPE</Name> <!-- required -->
                                <IsActive >BOOLTYPE</IsActive> <!-- optional -->
                                <IsTaxable >BOOLTYPE</IsTaxable> <!-- required -->
                                <Desc >STRTYPE</Desc> <!-- optional -->
                                <ItemPurchaseTaxRef> <!-- optional -->
                                        <ListID >IDTYPE</ListID> <!-- optional -->
                                        <FullName >STRTYPE</FullName> <!-- optional -->
                                </ItemPurchaseTaxRef>
                                <ItemSalesTaxRef> <!-- optional -->
                                        <ListID >IDTYPE</ListID> <!-- optional -->
                                        <FullName >STRTYPE</FullName> <!-- optional -->
                                </ItemSalesTaxRef>
                        </SalesTaxCodeRet>
                        <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>
                </SalesTaxCodeAddRs>
        </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
'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  DoSalesTaxCodeAdd()
                        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

                                BuildSalesTaxCodeAddRq(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

                                WalkSalesTaxCodeAddRs(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 BuildSalesTaxCodeAddRq(requestMsgSet as IMsgSetRequest)
                        Dim SalesTaxCodeAddRq as ISalesTaxCodeAdd
                        SalesTaxCodeAddRq= requestMsgSet.AppendSalesTaxCodeAddRq()
                        'Set field value for Name
                        SalesTaxCodeAddRq.Name.SetValue("ab")
                        'Set field value for IsActive
                        SalesTaxCodeAddRq.IsActive.SetValue(True)
                        'Set field value for IsTaxable
                        SalesTaxCodeAddRq.IsTaxable.SetValue(True)
                        'Set field value for Desc
                        SalesTaxCodeAddRq.Desc.SetValue("ab")
                        'Set field value for ListID
                        SalesTaxCodeAddRq.ItemPurchaseTaxRef.ListID.SetValue("200000-1011023419")
                        'Set field value for FullName
                        SalesTaxCodeAddRq.ItemPurchaseTaxRef.FullName.SetValue("ab")
                        'Set field value for ListID
                        SalesTaxCodeAddRq.ItemSalesTaxRef.ListID.SetValue("200000-1011023419")
                        'Set field value for FullName
                        SalesTaxCodeAddRq.ItemSalesTaxRef.FullName.SetValue("ab")
                        'Set field value for IncludeRetElementList
                        'May create more than one of these if needed
                        SalesTaxCodeAddRq.IncludeRetElementList.Add("ab")
                End Sub




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




                Public Sub WalkSalesTaxCodeRet(SalesTaxCodeRet as ISalesTaxCodeRet)
                        if (SalesTaxCodeRet is nothing) then
                                Exit Sub
                        End If

                        'Go through all the elements of ISalesTaxCodeRet
                        'Get value of ListID
                        Dim ListID21553 as String
                        ListID21553 = SalesTaxCodeRet.ListID.GetValue()
                        'Get value of TimeCreated
                        Dim TimeCreated21554 as DateTime
                        TimeCreated21554 = SalesTaxCodeRet.TimeCreated.GetValue()
                        'Get value of TimeModified
                        Dim TimeModified21555 as DateTime
                        TimeModified21555 = SalesTaxCodeRet.TimeModified.GetValue()
                        'Get value of EditSequence
                        Dim EditSequence21556 as String
                        EditSequence21556 = SalesTaxCodeRet.EditSequence.GetValue()
                        'Get value of Name
                        Dim Name21557 as String
                        Name21557 = SalesTaxCodeRet.Name.GetValue()
                        'Get value of IsActive
                        if ( not SalesTaxCodeRet.IsActive is nothing) then
                                Dim IsActive21558 as Boolean
                                IsActive21558 = SalesTaxCodeRet.IsActive.GetValue()
                        End If
                        'Get value of IsTaxable
                        Dim IsTaxable21559 as Boolean
                        IsTaxable21559 = SalesTaxCodeRet.IsTaxable.GetValue()
                        'Get value of Desc
                        if ( not SalesTaxCodeRet.Desc is nothing) then
                                Dim Desc216.0 as String
                                Desc216.0 = SalesTaxCodeRet.Desc.GetValue()
                        End If
                        if (not SalesTaxCodeRet.ItemPurchaseTaxRef. is nothing) then
                                'Get value of ListID
                                if ( not SalesTaxCodeRet.ItemPurchaseTaxRef.ListID is nothing) then
                                        Dim ListID21561 as String
                                        ListID21561 = SalesTaxCodeRet.ItemPurchaseTaxRef.ListID.GetValue()
                                End If
                                'Get value of FullName
                                if ( not SalesTaxCodeRet.ItemPurchaseTaxRef.FullName is nothing) then
                                        Dim FullName21562 as String
                                        FullName21562 = SalesTaxCodeRet.ItemPurchaseTaxRef.FullName.GetValue()
                                End If
                        End If
                        if (not SalesTaxCodeRet.ItemSalesTaxRef. is nothing) then
                                'Get value of ListID
                                if ( not SalesTaxCodeRet.ItemSalesTaxRef.ListID is nothing) then
                                        Dim ListID21563 as String
                                        ListID21563 = SalesTaxCodeRet.ItemSalesTaxRef.ListID.GetValue()
                                End If
                                'Get value of FullName
                                if ( not SalesTaxCodeRet.ItemSalesTaxRef.FullName is nothing) then
                                        Dim FullName21564 as String
                                        FullName21564 = SalesTaxCodeRet.ItemSalesTaxRef.FullName.GetValue()
                                End If
                        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
//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  DoSalesTaxCodeAdd()
                {
                        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;

                                BuildSalesTaxCodeAddRq(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;

                                WalkSalesTaxCodeAddRs(responseMsgSet);
                        }
                        catch (Exception e)
                        {
                                MessageBox.Show(e.Message, "Error");
                                if (sessionBegun)
                                {
                                        sessionManager.EndSession();
                                }
                                if (connectionOpen)
                                {
                                        sessionManager.CloseConnection();
                                }
                        }
                }
                void BuildSalesTaxCodeAddRq(IMsgSetRequest requestMsgSet)
                {
                        ISalesTaxCodeAdd SalesTaxCodeAddRq= requestMsgSet.AppendSalesTaxCodeAddRq();
                        //Set field value for Name
                        SalesTaxCodeAddRq.Name.SetValue("ab");
                        //Set field value for IsActive
                        SalesTaxCodeAddRq.IsActive.SetValue(true);
                        //Set field value for IsTaxable
                        SalesTaxCodeAddRq.IsTaxable.SetValue(true);
                        //Set field value for Desc
                        SalesTaxCodeAddRq.Desc.SetValue("ab");
                        //Set field value for ListID
                        SalesTaxCodeAddRq.ItemPurchaseTaxRef.ListID.SetValue("200000-1011023419");
                        //Set field value for FullName
                        SalesTaxCodeAddRq.ItemPurchaseTaxRef.FullName.SetValue("ab");
                        //Set field value for ListID
                        SalesTaxCodeAddRq.ItemSalesTaxRef.ListID.SetValue("200000-1011023419");
                        //Set field value for FullName
                        SalesTaxCodeAddRq.ItemSalesTaxRef.FullName.SetValue("ab");
                        //Set field value for IncludeRetElementList
                        //May create more than one of these if needed
                        SalesTaxCodeAddRq.IncludeRetElementList.Add("ab");
                }




                void WalkSalesTaxCodeAddRs(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.rtSalesTaxCodeAddRs)
                                                {
                                                        //upcast to more specific type here, this is safe because we checked with response.Type check above
                                                        ISalesTaxCodeRet SalesTaxCodeRet = (ISalesTaxCodeRet)response.Detail;
                                                        WalkSalesTaxCodeRet(SalesTaxCodeRet);
                                                }
                                        }
                                }
                        }
                }




                void WalkSalesTaxCodeRet(ISalesTaxCodeRet SalesTaxCodeRet)
                {
                        if (SalesTaxCodeRet == null) return;
                        //Go through all the elements of ISalesTaxCodeRet
                        //Get value of ListID
                        string ListID21541 = (string)SalesTaxCodeRet.ListID.GetValue();
                        //Get value of TimeCreated
                        DateTime TimeCreated21542 = (DateTime)SalesTaxCodeRet.TimeCreated.GetValue();
                        //Get value of TimeModified
                        DateTime TimeModified21543 = (DateTime)SalesTaxCodeRet.TimeModified.GetValue();
                        //Get value of EditSequence
                        string EditSequence21544 = (string)SalesTaxCodeRet.EditSequence.GetValue();
                        //Get value of Name
                        string Name21545 = (string)SalesTaxCodeRet.Name.GetValue();
                        //Get value of IsActive
                        if (SalesTaxCodeRet.IsActive != null)
                        {
                                bool IsActive21546 = (bool)SalesTaxCodeRet.IsActive.GetValue();
                        }
                        //Get value of IsTaxable
                        bool IsTaxable21547 = (bool)SalesTaxCodeRet.IsTaxable.GetValue();
                        //Get value of Desc
                        if (SalesTaxCodeRet.Desc != null)
                        {
                                string Desc21548 = (string)SalesTaxCodeRet.Desc.GetValue();
                        }
                        if (SalesTaxCodeRet.ItemPurchaseTaxRef != null)
                        {
                                //Get value of ListID
                                if (SalesTaxCodeRet.ItemPurchaseTaxRef.ListID != null)
                                {
                                        string ListID21549 = (string)SalesTaxCodeRet.ItemPurchaseTaxRef.ListID.GetValue();
                                }
                                //Get value of FullName
                                if (SalesTaxCodeRet.ItemPurchaseTaxRef.FullName != null)
                                {
                                        string FullName216.0 = (string)SalesTaxCodeRet.ItemPurchaseTaxRef.FullName.GetValue();
                                }
                        }
                        if (SalesTaxCodeRet.ItemSalesTaxRef != null)
                        {
                                //Get value of ListID
                                if (SalesTaxCodeRet.ItemSalesTaxRef.ListID != null)
                                {
                                        string ListID21551 = (string)SalesTaxCodeRet.ItemSalesTaxRef.ListID.GetValue();
                                }
                                //Get value of FullName
                                if (SalesTaxCodeRet.ItemSalesTaxRef.FullName != null)
                                {
                                        string FullName21552 = (string)SalesTaxCodeRet.ItemSalesTaxRef.FullName.GetValue();
                                }
                        }
                }




        }
}