PriceLevelQuery(4.0)
Queries for the specified price level or set of price levels.
Request
Response
XMLOps
VB.NET
C#
| Tag | Type | Max length | Implementation | Required |
|---|---|---|---|---|
IPriceLevelQuery
Queries for the specified price level or set of price levels.
|
4.0 | |||
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  |
||
ORPriceLevelQuery |
IORPriceLevelQuery | |||
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 | |||
PriceLevelFilter
The filter to be used in the PriceLevel query. You can filter on date modified, name, name range, and item.
|
IPriceLevelFilter | |||
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 | |||
ItemRef
Depending on the request containing it, ItemRef can refer to an item on any Item list such as ItemDiscount, ItemInventory, and so forth, or it may accept only a subset of item types. For example, here are some requests that impose limits on what items ItemRef can refer to. For PurchaseOrder and Bill requests, ItemRef cannot refer to discount items or sales-tax itemsFor VehicleMilageAdd requests, the ItemRef must refer to a service item or an other charge item.For BillingRateAdd requests, the ItemRef must refer to a service item. You can use an ItemQuery request to get information about all the items that are set up in the QuickBooks file. “Items” are line items used for fast entry on sales and purchase forms. They include services and goods that a business buys and sells, as well as special items that perform calculations–for example, subtotal, discount, and sales-tax items. Note: In a request, if an ItemRef 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 | |||
CurrencyFilter
Filters by the specified currency.
|
ICurrencyFilter | 8.0 | ||
ORCurrencyFilter |
IORCurrencyFilter | Y | ||
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 | 64 chars | ||
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 |
| Tag | Type | Max length | Implementation | Required |
|---|---|---|---|---|
IResponse
Queries for the specified price level or set of price levels.
|
4.0 | |||
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 |
Y | |
Detail |
IPriceLevelRetList | |||
(List
of IPriceLevelRet 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 | |||
TimeCreated
Time the object was created.
|
IQBDateTimeType | |||
TimeModified
Time the object was last modified.
|
IQBDateTimeType | |||
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 | ||
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 | ||
IsActive
If IsActive is true, this object is currently enabled for use by QuickBooks. The default value is true.
|
IQBBoolType | |||
PriceLevelType
The types of price level, fixed percentage type or per item types. Per item types are only supported in Premier or Enterprise.
|
IQBENPriceLevelTypeType | |||
ORPriceLevelRet |
IORPriceLevelRet | |||
PriceLevelFixedPercentage
When you create a price level, you must specify whether it is a fixed percentage or a per item price level. Once you create the price level, you cannot change this. QuickBooks Pro and greater versions support fixed percentages, but only QuickBooks Premier and Enterprise support the per item price level. Where is this discount applied if Price Levels are enabled in QuickBooks preferences? The discount is applied to the sales price of the item. If the price level is applied to a customer, it automatically adjusts the Rate and Amount columns for applicable line items in a QuickBooks Sales Order form, Invoice form, etc. for that customer. The QuickBooks user could still select a different price level. However, the customer price level simply establishes a default price. If no price level is applied to the customer, then the QuickBooks user can apply a price level by clicking the dropdown list of price levels that appears next to the Rate column. The default in this case is simply the sales price established for the item. Notice that this value supports both positive and negative values. For example, a value of 20 would increase the price by 20% and value of -10 would decrease the price by 10%.
|
IQBPercentType | |||
PriceLevelPerItemRetCurrency
When you create a price level, you must specify whether it is a fixed percentage or a per item price level. Once you create the price level, you cannot change this. Currently, only QuickBooks Premier and Enterprise support the per item price level.
|
IPriceLevelPerItemRetCurrency | |||
PriceLevelPerItemRetList
When you create a price level, you must specify whether it is a fixed percentage or a per item price level. Once you create the price level, you cannot change this. Currently, only QuickBooks Premier and Enterprise support the per item price level.
|
IPriceLevelPerItemRetList | Y | ||
(List
of IPriceLevelPerItemRet Objects)
|
||||
ItemRef
Depending on the request containing it, ItemRef can refer to an item on any Item list such as ItemDiscount, ItemInventory, and so forth, or it may accept only a subset of item types. For example, here are some requests that impose limits on what items ItemRef can refer to. For PurchaseOrder and Bill requests, ItemRef cannot refer to discount items or sales-tax itemsFor VehicleMilageAdd requests, the ItemRef must refer to a service item or an other charge item.For BillingRateAdd requests, the ItemRef must refer to a service item. You can use an ItemQuery request to get information about all the items that are set up in the QuickBooks file. “Items” are line items used for fast entry on sales and purchase forms. They include services and goods that a business buys and sells, as well as special items that perform calculations–for example, subtotal, discount, and sales-tax items. Note: In a request, if an ItemRef aggregate includes both FullName and ListID, FullName will be ignored.
|
IQBBaseRef | 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 | |||
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 | |||
ORORCustomPrice |
IORORCustomPrice | Y | ||
CustomPrice
When you create a price level, you have the option to create it with a custom price that is either a fixed amount (CustomPrice) or a fixed discount percentage (CustomPricePercent). Alternatively, instead of a flat custom price or discount, you could apply a price discount based on either the current custom price, the standard price of the item, or the cost of the item.
|
IQBPriceType | |||
CustomPricePercent
When you create a price level, you have the option to create it with a custom price that is either a fixed amount (CustomPrice) or a fixed discount percentage (CustomPricePercent).
|
IQBPercentType | |||
CurrencyRef
The currency object contains all of the information needed by QuickBooks to display and use. For built-in currencies, the name and currency code values are internationally accepted values and thus are not editable. The comma format is editable, as is the IsActive status. For user-defined currencies, every value in the object is editable including name and currency code. When used with PriceLevels, the CurrencyRef should only be used with “per item” price levels.
|
IQBBaseRef | 8.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 | 8.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 | 64 chars | 8.0 |
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 | <?xml version="1.0" encoding="utf-8"?> <?qbxml version="16.0"?> <QBXML> <QBXMLMsgsRq onError="stopOnError"> <PriceLevelQueryRq 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 --> <ItemRef> <!-- optional --> <ListID >IDTYPE</ListID> <!-- optional --> <FullName >STRTYPE</FullName> <!-- optional --> </ItemRef> <CurrencyFilter> <!-- optional --> <!-- BEGIN OR --> <ListID >IDTYPE</ListID> <!-- optional, may repeat --> <!-- OR --> <FullName >STRTYPE</FullName> <!-- optional, may repeat --> <!-- END OR --> </CurrencyFilter> <!-- END OR --> <IncludeRetElement >STRTYPE</IncludeRetElement> <!-- optional, may repeat --> </PriceLevelQueryRq> <PriceLevelQueryRs statusCode="INTTYPE" statusSeverity="STRTYPE" statusMessage="STRTYPE" retCount="INTTYPE"> <PriceLevelRet> <!-- optional, may repeat --> <ListID >IDTYPE</ListID> <!-- optional --> <TimeCreated >DATETIMETYPE</TimeCreated> <!-- optional --> <TimeModified >DATETIMETYPE</TimeModified> <!-- optional --> <EditSequence >STRTYPE</EditSequence> <!-- optional --> <Name >STRTYPE</Name> <!-- optional --> <IsActive >BOOLTYPE</IsActive> <!-- optional --> <!-- PriceLevelType may have one of the following values: FixedPercentage, PerItem --> <PriceLevelType >ENUMTYPE</PriceLevelType> <!-- optional --> <!-- BEGIN OR --> <PriceLevelFixedPercentage >PERCENTTYPE</PriceLevelFixedPercentage> <!-- optional --> <!-- OR --> <PriceLevelPerItemRet> <!-- required, may repeat --> <ItemRef> <!-- required --> <ListID >IDTYPE</ListID> <!-- optional --> <FullName >STRTYPE</FullName> <!-- optional --> </ItemRef> <!-- BEGIN OR --> <CustomPrice >PRICETYPE</CustomPrice> <!-- optional --> <!-- OR --> <CustomPricePercent >PERCENTTYPE</CustomPricePercent> <!-- optional --> <!-- END OR --> </PriceLevelPerItemRet> <CurrencyRef> <!-- optional --> <ListID >IDTYPE</ListID> <!-- optional --> <FullName >STRTYPE</FullName> <!-- optional --> </CurrencyRef> <!-- END OR --> </PriceLevelRet> </PriceLevelQueryRs> </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 | '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 DoPriceLevelQuery()
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
BuildPriceLevelQueryRq(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
WalkPriceLevelQueryRs(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 BuildPriceLevelQueryRq(requestMsgSet as IMsgSetRequest)
Dim PriceLevelQueryRq as IPriceLevelQuery
PriceLevelQueryRq= requestMsgSet.AppendPriceLevelQueryRq()
Dim ORPriceLevelQueryElementType17520 as String
ORPriceLevelQueryElementType17520 = "ListIDList"
if (ORPriceLevelQueryElementType17520 == "ListIDList") then
'Set field value for ListIDList
'May create more than one of these if needed
PriceLevelQueryRq.ORPriceLevelQuery.ListIDList.Add("200000-1011023419")
End If
if (ORPriceLevelQueryElementType17520 == "FullNameList") then
'Set field value for FullNameList
'May create more than one of these if needed
PriceLevelQueryRq.ORPriceLevelQuery.FullNameList.Add("ab")
End If
if (ORPriceLevelQueryElementType17520 == "PriceLevelFilter") then
'Set field value for MaxReturned
PriceLevelQueryRq.ORPriceLevelQuery.PriceLevelFilter.MaxReturned.SetValue(6)
'Set field value for ActiveStatus
PriceLevelQueryRq.ORPriceLevelQuery.PriceLevelFilter.ActiveStatus.SetValue(ENActiveStatus.asActiveOnly [DEFAULT])
'Set field value for FromModifiedDate
PriceLevelQueryRq.ORPriceLevelQuery.PriceLevelFilter.FromModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false)
'Set field value for ToModifiedDate
PriceLevelQueryRq.ORPriceLevelQuery.PriceLevelFilter.ToModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false)
Dim ORNameFilterElementType17521 as String
ORNameFilterElementType17521 = "NameFilter"
if (ORNameFilterElementType17521 == "NameFilter") then
'Set field value for MatchCriterion
PriceLevelQueryRq.ORPriceLevelQuery.PriceLevelFilter.ORNameFilter.NameFilter.MatchCriterion.SetValue(ENMatchCriterion.mcStartsWith)
'Set field value for Name
PriceLevelQueryRq.ORPriceLevelQuery.PriceLevelFilter.ORNameFilter.NameFilter.Name.SetValue("ab")
End If
if (ORNameFilterElementType17521 == "NameRangeFilter") then
'Set field value for FromName
PriceLevelQueryRq.ORPriceLevelQuery.PriceLevelFilter.ORNameFilter.NameRangeFilter.FromName.SetValue("ab")
'Set field value for ToName
PriceLevelQueryRq.ORPriceLevelQuery.PriceLevelFilter.ORNameFilter.NameRangeFilter.ToName.SetValue("ab")
End If
'Set field value for ListID
PriceLevelQueryRq.ORPriceLevelQuery.PriceLevelFilter.ItemRef.ListID.SetValue("200000-1011023419")
'Set field value for FullName
PriceLevelQueryRq.ORPriceLevelQuery.PriceLevelFilter.ItemRef.FullName.SetValue("ab")
Dim ORCurrencyFilterElementType17522 as String
ORCurrencyFilterElementType17522 = "ListIDList"
if (ORCurrencyFilterElementType17522 == "ListIDList") then
'Set field value for ListIDList
'May create more than one of these if needed
PriceLevelQueryRq.ORPriceLevelQuery.PriceLevelFilter.CurrencyFilter.ORCurrencyFilter.ListIDList.Add("200000-1011023419")
End If
if (ORCurrencyFilterElementType17522 == "FullNameList") then
'Set field value for FullNameList
'May create more than one of these if needed
PriceLevelQueryRq.ORPriceLevelQuery.PriceLevelFilter.CurrencyFilter.ORCurrencyFilter.FullNameList.Add("ab")
End If
End If
'Set field value for IncludeRetElementList
'May create more than one of these if needed
PriceLevelQueryRq.IncludeRetElementList.Add("ab")
End Sub
Public Sub WalkPriceLevelQueryRs( 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.rtPriceLevelQueryRs) then
'upcast to more specific type here, this is safe because we checked with response.Type check above
Dim PriceLevelRet as IPriceLevelRetList
PriceLevelRet = CType(response.Detail,IPriceLevelRetList)
WalkPriceLevelRet(PriceLevelRet)
End If
End If
End If
Next j
End Sub
Public Sub WalkPriceLevelRet(PriceLevelRet as IPriceLevelRetList)
if (PriceLevelRet is nothing) then
Exit Sub
End If
'Go through all the elements of IPriceLevelRetList
'Get value of ListID
if ( not PriceLevelRet.ListID is nothing) then
Dim ListID17523 as String
ListID17523 = PriceLevelRet.ListID.GetValue()
End If
'Get value of TimeCreated
if ( not PriceLevelRet.TimeCreated is nothing) then
Dim TimeCreated17524 as DateTime
TimeCreated17524 = PriceLevelRet.TimeCreated.GetValue()
End If
'Get value of TimeModified
if ( not PriceLevelRet.TimeModified is nothing) then
Dim TimeModified17525 as DateTime
TimeModified17525 = PriceLevelRet.TimeModified.GetValue()
End If
'Get value of EditSequence
if ( not PriceLevelRet.EditSequence is nothing) then
Dim EditSequence17526 as String
EditSequence17526 = PriceLevelRet.EditSequence.GetValue()
End If
'Get value of Name
if ( not PriceLevelRet.Name is nothing) then
Dim Name17527 as String
Name17527 = PriceLevelRet.Name.GetValue()
End If
'Get value of IsActive
if ( not PriceLevelRet.IsActive is nothing) then
Dim IsActive17528 as Boolean
IsActive17528 = PriceLevelRet.IsActive.GetValue()
End If
'Get value of PriceLevelType
if ( not PriceLevelRet.PriceLevelType is nothing) then
Dim PriceLevelType17529 as ENPriceLevelType
PriceLevelType17529 = PriceLevelRet.PriceLevelType.GetValue()
End If
if (not PriceLevelRet.ORPriceLevelRet is nothing) then
if (not PriceLevelRet.ORPriceLevelRet.PriceLevelFixedPercentage is nothing) then
'Get value of PriceLevelFixedPercentage
if ( not PriceLevelRet.ORPriceLevelRet.PriceLevelFixedPercentage is nothing) then
Dim PriceLevelFixedPercentage17531 as Double
PriceLevelFixedPercentage17531 = PriceLevelRet.ORPriceLevelRet.PriceLevelFixedPercentage.GetValue()
End If
End If
if (not PriceLevelRet.ORPriceLevelRet.PriceLevelPerItemRetCurrency is nothing) then
'Get value of PriceLevelPerItemRetCurrency
if ( not PriceLevelRet.ORPriceLevelRet.PriceLevelPerItemRetCurrency is nothing) then
Dim nothing17532 as IPriceLevelPerItemRetCurrency
nothing17532 = PriceLevelRet.ORPriceLevelRet.PriceLevelPerItemRetCurrency.GetValue()
End If
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 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 DoPriceLevelQuery() { 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; BuildPriceLevelQueryRq(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; WalkPriceLevelQueryRs(responseMsgSet); } catch (Exception e) { MessageBox.Show(e.Message, "Error"); if (sessionBegun) { sessionManager.EndSession(); } if (connectionOpen) { sessionManager.CloseConnection(); } } } void BuildPriceLevelQueryRq(IMsgSetRequest requestMsgSet) { IPriceLevelQuery PriceLevelQueryRq= requestMsgSet.AppendPriceLevelQueryRq(); //Set attributes //Set field value for metaData PriceLevelQueryRq.metaData.SetValue("IQBENmetaDataType"); string ORPriceLevelQueryElementType17507 = "ListIDList"; if (ORPriceLevelQueryElementType17507 == "ListIDList") { //Set field value for ListIDList //May create more than one of these if needed PriceLevelQueryRq.ORPriceLevelQuery.ListIDList.Add("200000-1011023419"); } if (ORPriceLevelQueryElementType17507 == "FullNameList") { //Set field value for FullNameList //May create more than one of these if needed PriceLevelQueryRq.ORPriceLevelQuery.FullNameList.Add("ab"); } if (ORPriceLevelQueryElementType17507 == "PriceLevelFilter") { //Set field value for MaxReturned PriceLevelQueryRq.ORPriceLevelQuery.PriceLevelFilter.MaxReturned.SetValue(6); //Set field value for ActiveStatus PriceLevelQueryRq.ORPriceLevelQuery.PriceLevelFilter.ActiveStatus.SetValue(ENActiveStatus.asActiveOnly [DEFAULT]); //Set field value for FromModifiedDate PriceLevelQueryRq.ORPriceLevelQuery.PriceLevelFilter.FromModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false); //Set field value for ToModifiedDate PriceLevelQueryRq.ORPriceLevelQuery.PriceLevelFilter.ToModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false); string ORNameFilterElementType17508 = "NameFilter"; if (ORNameFilterElementType17508 == "NameFilter") { //Set field value for MatchCriterion PriceLevelQueryRq.ORPriceLevelQuery.PriceLevelFilter.ORNameFilter.NameFilter.MatchCriterion.SetValue(ENMatchCriterion.mcStartsWith); //Set field value for Name PriceLevelQueryRq.ORPriceLevelQuery.PriceLevelFilter.ORNameFilter.NameFilter.Name.SetValue("ab"); } if (ORNameFilterElementType17508 == "NameRangeFilter") { //Set field value for FromName PriceLevelQueryRq.ORPriceLevelQuery.PriceLevelFilter.ORNameFilter.NameRangeFilter.FromName.SetValue("ab"); //Set field value for ToName PriceLevelQueryRq.ORPriceLevelQuery.PriceLevelFilter.ORNameFilter.NameRangeFilter.ToName.SetValue("ab"); } //Set field value for ListID PriceLevelQueryRq.ORPriceLevelQuery.PriceLevelFilter.ItemRef.ListID.SetValue("200000-1011023419"); //Set field value for FullName PriceLevelQueryRq.ORPriceLevelQuery.PriceLevelFilter.ItemRef.FullName.SetValue("ab"); string ORCurrencyFilterElementType17509 = "ListIDList"; if (ORCurrencyFilterElementType17509 == "ListIDList") { //Set field value for ListIDList //May create more than one of these if needed PriceLevelQueryRq.ORPriceLevelQuery.PriceLevelFilter.CurrencyFilter.ORCurrencyFilter.ListIDList.Add("200000-1011023419"); } if (ORCurrencyFilterElementType17509 == "FullNameList") { //Set field value for FullNameList //May create more than one of these if needed PriceLevelQueryRq.ORPriceLevelQuery.PriceLevelFilter.CurrencyFilter.ORCurrencyFilter.FullNameList.Add("ab"); } } //Set field value for IncludeRetElementList //May create more than one of these if needed PriceLevelQueryRq.IncludeRetElementList.Add("ab"); } void WalkPriceLevelQueryRs(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.rtPriceLevelQueryRs) { //upcast to more specific type here, this is safe because we checked with response.Type check above IPriceLevelRetList PriceLevelRet = (IPriceLevelRetList)response.Detail; WalkPriceLevelRet(PriceLevelRet); } } } } } void WalkPriceLevelRet(IPriceLevelRetList PriceLevelRet) { if (PriceLevelRet == null) return; //Go through all the elements of IPriceLevelRetList //Get value of ListID if (PriceLevelRet.ListID != null) { string ListID17510 = (string)PriceLevelRet.ListID.GetValue(); } //Get value of TimeCreated if (PriceLevelRet.TimeCreated != null) { DateTime TimeCreated17511 = (DateTime)PriceLevelRet.TimeCreated.GetValue(); } //Get value of TimeModified if (PriceLevelRet.TimeModified != null) { DateTime TimeModified17512 = (DateTime)PriceLevelRet.TimeModified.GetValue(); } //Get value of EditSequence if (PriceLevelRet.EditSequence != null) { string EditSequence17513 = (string)PriceLevelRet.EditSequence.GetValue(); } //Get value of Name if (PriceLevelRet.Name != null) { string Name17514 = (string)PriceLevelRet.Name.GetValue(); } //Get value of IsActive if (PriceLevelRet.IsActive != null) { bool IsActive17515 = (bool)PriceLevelRet.IsActive.GetValue(); } //Get value of PriceLevelType if (PriceLevelRet.PriceLevelType != null) { ENPriceLevelType PriceLevelType17516 = (ENPriceLevelType)PriceLevelRet.PriceLevelType.GetValue(); } if (PriceLevelRet.ORPriceLevelRet != null) { if (PriceLevelRet.ORPriceLevelRet.PriceLevelFixedPercentage != null) { //Get value of PriceLevelFixedPercentage if (PriceLevelRet.ORPriceLevelRet.PriceLevelFixedPercentage != null) { double PriceLevelFixedPercentage17518 = (double)PriceLevelRet.ORPriceLevelRet.PriceLevelFixedPercentage.GetValue(); } } if (PriceLevelRet.ORPriceLevelRet.PriceLevelPerItemRetCurrency != null) { //Get value of PriceLevelPerItemRetCurrency if (PriceLevelRet.ORPriceLevelRet.PriceLevelPerItemRetCurrency != null) { IPriceLevelPerItemRetCurrency nothing17519 = (IPriceLevelPerItemRetCurrency)PriceLevelRet.ORPriceLevelRet.PriceLevelPerItemRetCurrency.GetValue(); } } } } } } |