SalesTaxCodeQuery

Queries for the specified sales tax code or set of codes.


Request

Response

XMLOps

VB.NET

C#

Tag Type Max length Implementation Required

ISalesTaxCodeQuery

Queries for the specified sales tax code or set of codes.
        

metaData

This is used in a query to cause a count of query objects to be returned. You can specify that the count of query objects is to be returned with the returned objects, or you can specify that only a count and no data is returned. (The default is that no count is returned.) A common use of this feature is to specify a count with no data in order to determine how many objects to expect from the actual query. If you don’t want a query to return a count, either don’t use this feature, or specify the value NoMetaData. If you want only a count, specify the value MetaDataOnly. If you want data and a count, specify MetaDataAndResponseData. You should be aware that the count returned via this setting is not guaranteed to be exact: it could be off slightly due to new object creation or deletions.
 IQBENmetaDataType   4.0 us.png  

ORListQuery

 IORListQuery      

ListIDList

One or more ListID values. 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.
 IBSTRList      

FullNameList

A list of one or more FullName values. 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.
 IBSTRList      

ListFilter

The IListFilter group object allows you to search according to active status, modification date, and name.
 IListFilter      

MaxReturned

Limits the number of objects that a query returns. (To get a count of how many objects could possibly be returned, use the metaData query attribute.) If you include a MaxReturned value, it must be at least 1.
 IQBIntType      

ActiveStatus

Used in filters to select list objects based on whether or not they are currently enabled for use by QuickBooks. The default value is asActiveOnly, which selects only list objects that are active.
 IQBENActiveStatusType      

FromModifiedDate

Selects objects modified on or after this date. See the note below regarding QBFC usage.For desktop versions of QuickBooks, the FromModifiedDate and ToModifiedDate must be between 1970-01-01 and 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). (The time portion of the field was not supported in qbXML version 1.0 or 1.1.) Also, for desktop versions of QuickBooks, if FromModifiedDate includes a date but not a time (for example, if you set FromModifiedDate to 2003-02-14), the time is assumed to be zero (2003-02-14T00:00:00). If you omit FromModifiedDate, it will be set to 1970-01-01T00:00:00 (1969-12-31T16:00:00-08:00 PST).For QBOE, the FromModifiedDate and ToModifiedDate must be between 1900-01-01T00:00:00 and 9999-12-31T00:00:00. If FromModifiedDate includes a date but not a time (for example, if you set FromModifiedDate to 2003-02-14), the time is assumed to be zero (2003-02-14T00:00:00). If you omit FromModifiedDate, it will be set to 1900-01-01T00:00:00.Note: When specifying this in QBFC, you need to supply the parameter asDateOnly, which is a Boolean. If asDateOnly is true, the date value will be represented as a date only (without a time). If asDateOnly is false, the date value will be represented as date and time, padded with zeros if necessary, and set to the beginning of the day if no time is provided. The asDateOnly parameter is especially useful in the ToModifiedDate field of a query: If asDateOnly is set to true in the ToModifiedDate field of a query, then the query includes elements modified up to the end of the day. If asDateOnly is false, the query includes elements modified up to the specified time (or up to the beginning of the day if no time is included).
 IQBDateTimeType      

ToModifiedDate

Selects objects modified on or before this date. See the note below on QBFC usage.For desktop versions of QuickBooks, the ToModifiedDate and FromModifiedDate must be between 01/01/1970 and 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). (Note that the time portion of the field was not supported in qbXML version 1.0 or 1.1.) If ToModifiedDate includes a date but not a time (for example, if you set ToModifiedDate to 2003-02-14), the time is assumed to be the end of the day (2003-02-14T23:59:59). If you omit ToModifiedDate altogether, it will be set to 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST).For QBOE, the ToModifiedDate and FromModifiedDate must be between 01/01/1900 and 9999-12-31T00:00:00. If ToModifiedDate includes a date but not a time (for example, if you set ToModifiedDate to 2003-02-14), the time is assumed to be the end of the day (2003-02-14T23:59:59). If you omit ToModifiedDate altogether, it will be set to 9999-12-31T00:00:00.Note: When specifying this in QBFC, you need to supply the parameter asDateOnly, which is a Boolean. If asDateOnly is true, the date value will be represented as a date only (without a time). If asDateOnly is false, the date value will be represented as date and time, padded with zeros if necessary, and set to the beginning of the day if no time is provided. The asDateOnly parameter is especially useful in the ToModifiedDate field of a query: If asDateOnly is set to true in the ToModifiedDate field of a query, then the query includes elements modified up to the end of the day. If asDateOnly is false, the query includes elements modified up to the specified time (or up to the beginning of the day if no time is included).
 IQBDateTimeType      

ORNameFilter

 IORNameFilter      

NameFilter

Filters according to the object’s Name.
 INameFilter      

MatchCriterion

The criterion to match.
 IQBENMatchCriterionType     Y

Name

The string to match.
 IQBStringType     Y

NameRangeFilter

Filters according to the object’s Name.
 INameRangeFilter      

FromName

The first name or item in the search range. If FromName is omitted, the range will begin with first name on the list.
 IQBStringType      

ToName

The final name or item in the search range. If ToName is omitted, the range will end with last name on the list.
 IQBStringType      

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

Queries for the specified sales tax code or set of codes.
        

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

retCount

The retCount is returned in a query if in the query request you specified the metaData attribute with a value of MetaDataOnly (in which case the retCount is the only data returned in the query response) or MetaDataAndResponseData (the query response contains object data AND the approximate count). The retCount value contains the approximate count of the objects that could be expected to be returned from the query. A common use of this feature is to specify a count with no data in order to determine how many objects to expect from the actual query. You should be aware that the count returned in retCount is not guaranteed to be exact: it could be off slightly due to new object creation or deletions.
 IQBIntType   4.0 us.png Y

Detail

 ISalesTaxCodeRetList      

(List

of ISalesTaxCodeRet Objects)
        

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   

 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
<?xml version="1.0" encoding="utf-8"?>
<?qbxml version="16.0"?>
<QBXML>
        <QBXMLMsgsRq onError="stopOnError">
                <SalesTaxCodeQueryRq metaData="ENUMTYPE">
                        <!-- BEGIN OR -->
                                <ListID >IDTYPE</ListID> <!-- optional, may repeat -->
                        <!-- OR -->
                                <FullName >STRTYPE</FullName> <!-- optional, may repeat -->
                        <!-- OR -->
                                <MaxReturned >INTTYPE</MaxReturned> <!-- optional -->
                                <!-- ActiveStatus may have one of the following values: ActiveOnly [DEFAULT], InactiveOnly, All -->
                                <ActiveStatus >ENUMTYPE</ActiveStatus> <!-- optional -->
                                <FromModifiedDate >DATETIMETYPE</FromModifiedDate> <!-- optional -->
                                <ToModifiedDate >DATETIMETYPE</ToModifiedDate> <!-- optional -->
                                <!-- BEGIN OR -->
                                        <NameFilter> <!-- optional -->
                                                <!-- MatchCriterion may have one of the following values: StartsWith, Contains, EndsWith -->
                                                <MatchCriterion >ENUMTYPE</MatchCriterion> <!-- required -->
                                                <Name >STRTYPE</Name> <!-- required -->
                                        </NameFilter>
                                <!-- OR -->
                                        <NameRangeFilter> <!-- optional -->
                                                <FromName >STRTYPE</FromName> <!-- optional -->
                                                <ToName >STRTYPE</ToName> <!-- optional -->
                                        </NameRangeFilter>
                                <!-- END OR -->
                        <!-- END OR -->
                        <IncludeRetElement >STRTYPE</IncludeRetElement> <!-- optional, may repeat -->
                </SalesTaxCodeQueryRq>

                <SalesTaxCodeQueryRs statusCode="INTTYPE" statusSeverity="STRTYPE" statusMessage="STRTYPE" retCount="INTTYPE">
                        <SalesTaxCodeRet> <!-- optional, may repeat -->
                                <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>
                </SalesTaxCodeQueryRs>
        </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
'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  DoSalesTaxCodeQuery()
                        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

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

                                WalkSalesTaxCodeQueryRs(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 BuildSalesTaxCodeQueryRq(requestMsgSet as IMsgSetRequest)
                        Dim SalesTaxCodeQueryRq as ISalesTaxCodeQuery
                        SalesTaxCodeQueryRq= requestMsgSet.AppendSalesTaxCodeQueryRq()
                        Dim ORListQueryElementType21603 as String
                        ORListQueryElementType21603 = "ListIDList"
                        if (ORListQueryElementType21603 == "ListIDList") then
                                'Set field value for ListIDList
                                'May create more than one of these if needed
                                SalesTaxCodeQueryRq.ORListQuery.ListIDList.Add("200000-1011023419")
                        End If
                        if (ORListQueryElementType21603 == "FullNameList") then
                                'Set field value for FullNameList
                                'May create more than one of these if needed
                                SalesTaxCodeQueryRq.ORListQuery.FullNameList.Add("ab")
                        End If
                        if (ORListQueryElementType21603 == "ListFilter") then
                                'Set field value for MaxReturned
                                SalesTaxCodeQueryRq.ORListQuery.ListFilter.MaxReturned.SetValue(6)
                                'Set field value for ActiveStatus
                                SalesTaxCodeQueryRq.ORListQuery.ListFilter.ActiveStatus.SetValue(ENActiveStatus.asActiveOnly [DEFAULT])
                                'Set field value for FromModifiedDate
                                SalesTaxCodeQueryRq.ORListQuery.ListFilter.FromModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false)
                                'Set field value for ToModifiedDate
                                SalesTaxCodeQueryRq.ORListQuery.ListFilter.ToModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false)
                                Dim ORNameFilterElementType21604 as String
                                ORNameFilterElementType21604 = "NameFilter"
                                if (ORNameFilterElementType21604 == "NameFilter") then
                                        'Set field value for MatchCriterion
                                        SalesTaxCodeQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.MatchCriterion.SetValue(ENMatchCriterion.mcStartsWith)
                                        'Set field value for Name
                                        SalesTaxCodeQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.Name.SetValue("ab")
                                End If
                                if (ORNameFilterElementType21604 == "NameRangeFilter") then
                                        'Set field value for FromName
                                        SalesTaxCodeQueryRq.ORListQuery.ListFilter.ORNameFilter.NameRangeFilter.FromName.SetValue("ab")
                                        'Set field value for ToName
                                        SalesTaxCodeQueryRq.ORListQuery.ListFilter.ORNameFilter.NameRangeFilter.ToName.SetValue("ab")
                                End If
                        End If
                        'Set field value for IncludeRetElementList
                        'May create more than one of these if needed
                        SalesTaxCodeQueryRq.IncludeRetElementList.Add("ab")
                End Sub




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




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

                        'Go through all the elements of ISalesTaxCodeRetList
                        'Get value of ListID
                        Dim ListID21605 as String
                        ListID21605 = SalesTaxCodeRet.ListID.GetValue()
                        'Get value of TimeCreated
                        Dim TimeCreated21606 as DateTime
                        TimeCreated21606 = SalesTaxCodeRet.TimeCreated.GetValue()
                        'Get value of TimeModified
                        Dim TimeModified21607 as DateTime
                        TimeModified21607 = SalesTaxCodeRet.TimeModified.GetValue()
                        'Get value of EditSequence
                        Dim EditSequence21608 as String
                        EditSequence21608 = SalesTaxCodeRet.EditSequence.GetValue()
                        'Get value of Name
                        Dim Name21609 as String
                        Name21609 = SalesTaxCodeRet.Name.GetValue()
                        'Get value of IsActive
                        if ( not SalesTaxCodeRet.IsActive is nothing) then
                                Dim IsActive21610 as Boolean
                                IsActive21610 = SalesTaxCodeRet.IsActive.GetValue()
                        End If
                        'Get value of IsTaxable
                        Dim IsTaxable21611 as Boolean
                        IsTaxable21611 = SalesTaxCodeRet.IsTaxable.GetValue()
                        'Get value of Desc
                        if ( not SalesTaxCodeRet.Desc is nothing) then
                                Dim Desc21612 as String
                                Desc21612 = 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 ListID21613 as String
                                        ListID21613 = SalesTaxCodeRet.ItemPurchaseTaxRef.ListID.GetValue()
                                End If
                                'Get value of FullName
                                if ( not SalesTaxCodeRet.ItemPurchaseTaxRef.FullName is nothing) then
                                        Dim FullName21614 as String
                                        FullName21614 = 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 ListID21615 as String
                                        ListID21615 = SalesTaxCodeRet.ItemSalesTaxRef.ListID.GetValue()
                                End If
                                'Get value of FullName
                                if ( not SalesTaxCodeRet.ItemSalesTaxRef.FullName is nothing) then
                                        Dim FullName21616 as String
                                        FullName21616 = 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
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
//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  DoSalesTaxCodeQuery()
                {
                        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;

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

                                WalkSalesTaxCodeQueryRs(responseMsgSet);
                        }
                        catch (Exception e)
                        {
                                MessageBox.Show(e.Message, "Error");
                                if (sessionBegun)
                                {
                                        sessionManager.EndSession();
                                }
                                if (connectionOpen)
                                {
                                        sessionManager.CloseConnection();
                                }
                        }
                }
                void BuildSalesTaxCodeQueryRq(IMsgSetRequest requestMsgSet)
                {
                        ISalesTaxCodeQuery SalesTaxCodeQueryRq= requestMsgSet.AppendSalesTaxCodeQueryRq();
                        //Set attributes
                        //Set field value for metaData
                        SalesTaxCodeQueryRq.metaData.SetValue("IQBENmetaDataType");
                        string ORListQueryElementType21589 = "ListIDList";
                        if (ORListQueryElementType21589 == "ListIDList")
                        {
                                //Set field value for ListIDList
                                //May create more than one of these if needed
                                SalesTaxCodeQueryRq.ORListQuery.ListIDList.Add("200000-1011023419");
                        }
                        if (ORListQueryElementType21589 == "FullNameList")
                        {
                                //Set field value for FullNameList
                                //May create more than one of these if needed
                                SalesTaxCodeQueryRq.ORListQuery.FullNameList.Add("ab");
                        }
                        if (ORListQueryElementType21589 == "ListFilter")
                        {
                                //Set field value for MaxReturned
                                SalesTaxCodeQueryRq.ORListQuery.ListFilter.MaxReturned.SetValue(6);
                                //Set field value for ActiveStatus
                                SalesTaxCodeQueryRq.ORListQuery.ListFilter.ActiveStatus.SetValue(ENActiveStatus.asActiveOnly [DEFAULT]);
                                //Set field value for FromModifiedDate
                                SalesTaxCodeQueryRq.ORListQuery.ListFilter.FromModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false);
                                //Set field value for ToModifiedDate
                                SalesTaxCodeQueryRq.ORListQuery.ListFilter.ToModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false);
                                string ORNameFilterElementType216.0 = "NameFilter";
                                if (ORNameFilterElementType216.0 == "NameFilter")
                                {
                                        //Set field value for MatchCriterion
                                        SalesTaxCodeQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.MatchCriterion.SetValue(ENMatchCriterion.mcStartsWith);
                                        //Set field value for Name
                                        SalesTaxCodeQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.Name.SetValue("ab");
                                }
                                if (ORNameFilterElementType216.0 == "NameRangeFilter")
                                {
                                        //Set field value for FromName
                                        SalesTaxCodeQueryRq.ORListQuery.ListFilter.ORNameFilter.NameRangeFilter.FromName.SetValue("ab");
                                        //Set field value for ToName
                                        SalesTaxCodeQueryRq.ORListQuery.ListFilter.ORNameFilter.NameRangeFilter.ToName.SetValue("ab");
                                }
                        }
                        //Set field value for IncludeRetElementList
                        //May create more than one of these if needed
                        SalesTaxCodeQueryRq.IncludeRetElementList.Add("ab");
                }




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




                void WalkSalesTaxCodeRet(ISalesTaxCodeRetList SalesTaxCodeRet)
                {
                        if (SalesTaxCodeRet == null) return;
                        //Go through all the elements of ISalesTaxCodeRetList
                        //Get value of ListID
                        string ListID21591 = (string)SalesTaxCodeRet.ListID.GetValue();
                        //Get value of TimeCreated
                        DateTime TimeCreated21592 = (DateTime)SalesTaxCodeRet.TimeCreated.GetValue();
                        //Get value of TimeModified
                        DateTime TimeModified21593 = (DateTime)SalesTaxCodeRet.TimeModified.GetValue();
                        //Get value of EditSequence
                        string EditSequence21594 = (string)SalesTaxCodeRet.EditSequence.GetValue();
                        //Get value of Name
                        string Name21595 = (string)SalesTaxCodeRet.Name.GetValue();
                        //Get value of IsActive
                        if (SalesTaxCodeRet.IsActive != null)
                        {
                                bool IsActive21596 = (bool)SalesTaxCodeRet.IsActive.GetValue();
                        }
                        //Get value of IsTaxable
                        bool IsTaxable21597 = (bool)SalesTaxCodeRet.IsTaxable.GetValue();
                        //Get value of Desc
                        if (SalesTaxCodeRet.Desc != null)
                        {
                                string Desc21598 = (string)SalesTaxCodeRet.Desc.GetValue();
                        }
                        if (SalesTaxCodeRet.ItemPurchaseTaxRef != null)
                        {
                                //Get value of ListID
                                if (SalesTaxCodeRet.ItemPurchaseTaxRef.ListID != null)
                                {
                                        string ListID21599 = (string)SalesTaxCodeRet.ItemPurchaseTaxRef.ListID.GetValue();
                                }
                                //Get value of FullName
                                if (SalesTaxCodeRet.ItemPurchaseTaxRef.FullName != null)
                                {
                                        string FullName21600 = (string)SalesTaxCodeRet.ItemPurchaseTaxRef.FullName.GetValue();
                                }
                        }
                        if (SalesTaxCodeRet.ItemSalesTaxRef != null)
                        {
                                //Get value of ListID
                                if (SalesTaxCodeRet.ItemSalesTaxRef.ListID != null)
                                {
                                        string ListID21601 = (string)SalesTaxCodeRet.ItemSalesTaxRef.ListID.GetValue();
                                }
                                //Get value of FullName
                                if (SalesTaxCodeRet.ItemSalesTaxRef.FullName != null)
                                {
                                        string FullName21602 = (string)SalesTaxCodeRet.ItemSalesTaxRef.FullName.GetValue();
                                }
                        }
                }




        }
}