TermsQuery
Queries for the terms or set of terms. Refers to the payment terms associated with this entity. (This will be an item on the DateDrivenTerms or StandardTerms list.) If a TermsRef aggregate includes both FullName and ListID, FullName will be ignored.
Request
Response
XMLOps
VB.NET
C#
| Tag | Type | Max length | Implementation | Required |
|---|---|---|---|---|
ITermsQuery
Queries for the terms or set of terms. Refers to the payment terms associated with this entity. (This will be an item on the DateDrivenTerms or StandardTerms list.) If a TermsRef aggregate includes both FullName and ListID, FullName will be ignored.
|
||||
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  |
||
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 terms or set of terms. Refers to the payment terms associated with this entity. (This will be an item on the DateDrivenTerms or StandardTerms list.) If a TermsRef aggregate includes both FullName and ListID, FullName will be ignored.
|
||||
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 |
IORTermsRetList | |||
(List
of IORTermsRet Objects)
|
||||
StandardTermsRet
Standard terms show the number of days within which payment is due and can include a discount for early payment. For example, the following standard term means that payment is due in 30 days, with a 1% discount if payment is made within 10 days: 1% 10 Net 30 Payments with date-driven terms, on the other hand, are due by a certain date.
|
IStandardTermsRet | |||
ListID
Along with FullName, ListID is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a ListID. A ListID is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same ListID, and a customer could not have the same ListID as an employee (because Customer and Employee are both name lists). But a customer could have the same ListID as a non-inventory item.
|
IQBIDType | Y | ||
TimeCreated
Time the object was created.
|
IQBDateTimeType | Y | ||
TimeModified
Time the object was last modified.
|
IQBDateTimeType | Y | ||
EditSequence
A number that the server generates and assigns to this object. Every time the object is changed, the server will change its EditSequence value. When you try to modify a list object, you must provide its EditSequence. The server compares the EditSequence you provide with the EditSequence in memory to make sure you are dealing with the latest copy of the object. If you are not, the server will reject the request and return an error. Because EditSequence is only used to check whether two objects match, there is no reason to interpret its value.
|
IQBStringType | 16 chars | Y | |
Name
The case-insensitive name of a list object, not including the names of its ancestors. Name must be unique, unless it is the Name of a “hierarchical” list object. List objects in different hierarchies can have duplicate names because their FullNames will still be unique. For example, two objects could both have the Name kitchen, but they could have unique FullNames, such as Job12:kitchen and Baker:kitchen. For built-in currencies, Name is the internationally accepted currency name and is not editable.
|
IQBStringType | 31 chars | Y | |
IsActive
If IsActive is true, this object is currently enabled for use by QuickBooks. The default value is true.
|
IQBBoolType | |||
StdDueDays
The number of days until payment is due.
|
IQBIntType | |||
StdDiscountDays
If payment is received within StdDiscountDays number of days, then DiscountPct will apply to the payment.
|
IQBIntType | |||
DiscountPct
If payment is received within StdDiscountDays number of days, then this discount will apply to the payment. DiscountPct must be between 0 and 100.
|
IQBPercentType | |||
DateDrivenTermsRet
Date-driven terms show the day of the month by which payment is due and can include a discount for early payment. For example, the following date-driven term means that payment is due on the 30th of the month, with a 1% discount if payment is made by the 10th: 1% 10 Net 30 Payments with standard terms, on the other hand, are due within a certain number of days.
|
IDateDrivenTermsRet | |||
ListID
Along with FullName, ListID is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a ListID. A ListID is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same ListID, and a customer could not have the same ListID as an employee (because Customer and Employee are both name lists). But a customer could have the same ListID as a non-inventory item.
|
IQBIDType | Y | ||
TimeCreated
Time the object was created.
|
IQBDateTimeType | Y | ||
TimeModified
Time the object was last modified.
|
IQBDateTimeType | Y | ||
EditSequence
A number that the server generates and assigns to this object. Every time the object is changed, the server will change its EditSequence value. When you try to modify a list object, you must provide its EditSequence. The server compares the EditSequence you provide with the EditSequence in memory to make sure you are dealing with the latest copy of the object. If you are not, the server will reject the request and return an error. Because EditSequence is only used to check whether two objects match, there is no reason to interpret its value.
|
IQBStringType | 16 chars | Y | |
Name
The case-insensitive name of a list object, not including the names of its ancestors. Name must be unique, unless it is the Name of a “hierarchical” list object. List objects in different hierarchies can have duplicate names because their FullNames will still be unique. For example, two objects could both have the Name kitchen, but they could have unique FullNames, such as Job12:kitchen and Baker:kitchen. For built-in currencies, Name is the internationally accepted currency name and is not editable.
|
IQBStringType | 31 chars | Y | |
IsActive
If IsActive is true, this object is currently enabled for use by QuickBooks. The default value is true.
|
IQBBoolType | |||
DayOfMonthDue
The day of the month when full payment is due with no discount.
|
IQBIntType | 31 chars | Y | |
DueNextMonthDays
Handles cases when an invoice or bill is issued close to its due date. If the invoice or bill is issued within this many days of the due date, payment is not due until the following month. For example, with a DayOfMonthDue of 15 and a DueNextMonthDays of 2, an invoice issued on May 13th would not be due until June 15th.
|
IQBIntType | |||
DiscountDayOfMonth
If the payment is made by this day of the month, then DiscountPct applies.
|
IQBIntType | 31 chars | ||
DiscountPct
If payment is received by DiscountDayOfMonth, then this discount will apply to the payment. DiscountPct must be between 0 and 100.
|
IQBPercentType |
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 | <?xml version="1.0" encoding="utf-8"?> <?qbxml version="17.0"?> <QBXML> <QBXMLMsgsRq onError="stopOnError"> <TermsQueryRq 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 --> </TermsQueryRq> <TermsQueryRs statusCode="INTTYPE" statusSeverity="STRTYPE" statusMessage="STRTYPE" retCount="INTTYPE"> <!-- BEGIN OR --> <StandardTermsRet> <!-- 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 --> <StdDueDays >INTTYPE</StdDueDays> <!-- optional --> <StdDiscountDays >INTTYPE</StdDiscountDays> <!-- optional --> <DiscountPct >PERCENTTYPE</DiscountPct> <!-- optional --> </StandardTermsRet> <!-- OR --> <DateDrivenTermsRet> <!-- 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 --> <DayOfMonthDue >INTTYPE</DayOfMonthDue> <!-- required --> <DueNextMonthDays >INTTYPE</DueNextMonthDays> <!-- optional --> <DiscountDayOfMonth >INTTYPE</DiscountDayOfMonth> <!-- optional --> <DiscountPct >PERCENTTYPE</DiscountPct> <!-- optional --> </DateDrivenTermsRet> <!-- END OR --> </TermsQueryRs> </QBXMLMsgsRq> </QBXML> |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 | '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 DoTermsQuery()
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
BuildTermsQueryRq(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
WalkTermsQueryRs(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 BuildTermsQueryRq(requestMsgSet as IMsgSetRequest)
Dim TermsQueryRq as ITermsQuery
TermsQueryRq= requestMsgSet.AppendTermsQueryRq()
Dim ORListQueryElementType22228 as String
ORListQueryElementType22228 = "ListIDList"
if (ORListQueryElementType22228 == "ListIDList") then
'Set field value for ListIDList
'May create more than one of these if needed
TermsQueryRq.ORListQuery.ListIDList.Add("200000-1011023419")
End If
if (ORListQueryElementType22228 == "FullNameList") then
'Set field value for FullNameList
'May create more than one of these if needed
TermsQueryRq.ORListQuery.FullNameList.Add("ab")
End If
if (ORListQueryElementType22228 == "ListFilter") then
'Set field value for MaxReturned
TermsQueryRq.ORListQuery.ListFilter.MaxReturned.SetValue(6)
'Set field value for ActiveStatus
TermsQueryRq.ORListQuery.ListFilter.ActiveStatus.SetValue(ENActiveStatus.asActiveOnly [DEFAULT])
'Set field value for FromModifiedDate
TermsQueryRq.ORListQuery.ListFilter.FromModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false)
'Set field value for ToModifiedDate
TermsQueryRq.ORListQuery.ListFilter.ToModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false)
Dim ORNameFilterElementType22229 as String
ORNameFilterElementType22229 = "NameFilter"
if (ORNameFilterElementType22229 == "NameFilter") then
'Set field value for MatchCriterion
TermsQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.MatchCriterion.SetValue(ENMatchCriterion.mcStartsWith)
'Set field value for Name
TermsQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.Name.SetValue("ab")
End If
if (ORNameFilterElementType22229 == "NameRangeFilter") then
'Set field value for FromName
TermsQueryRq.ORListQuery.ListFilter.ORNameFilter.NameRangeFilter.FromName.SetValue("ab")
'Set field value for ToName
TermsQueryRq.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
TermsQueryRq.IncludeRetElementList.Add("ab")
End Sub
Public Sub WalkTermsQueryRs( 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.rtTermsQueryRs) then
'upcast to more specific type here, this is safe because we checked with response.Type check above
Dim OR as IORTermsRetList
OR = CType(response.Detail,IORTermsRetList)
WalkOR(OR)
End If
End If
End If
Next j
End Sub
Public Sub WalkOR(OR as IORTermsRetList)
if (OR is nothing) then
Exit Sub
End If
'Go through all the elements of IORTermsRetList
if (not OR.StandardTermsRet. is nothing) then
'Get value of ListID
Dim ListID22230 as String
ListID22230 = OR.StandardTermsRet.ListID.GetValue()
'Get value of TimeCreated
Dim TimeCreated22231 as DateTime
TimeCreated22231 = OR.StandardTermsRet.TimeCreated.GetValue()
'Get value of TimeModified
Dim TimeModified22232 as DateTime
TimeModified22232 = OR.StandardTermsRet.TimeModified.GetValue()
'Get value of EditSequence
Dim EditSequence22233 as String
EditSequence22233 = OR.StandardTermsRet.EditSequence.GetValue()
'Get value of Name
Dim Name22234 as String
Name22234 = OR.StandardTermsRet.Name.GetValue()
'Get value of IsActive
if ( not OR.StandardTermsRet.IsActive is nothing) then
Dim IsActive22235 as Boolean
IsActive22235 = OR.StandardTermsRet.IsActive.GetValue()
End If
'Get value of StdDueDays
if ( not OR.StandardTermsRet.StdDueDays is nothing) then
Dim StdDueDays22236 as Integer
StdDueDays22236 = OR.StandardTermsRet.StdDueDays.GetValue()
End If
'Get value of StdDiscountDays
if ( not OR.StandardTermsRet.StdDiscountDays is nothing) then
Dim StdDiscountDays22237 as Integer
StdDiscountDays22237 = OR.StandardTermsRet.StdDiscountDays.GetValue()
End If
'Get value of DiscountPct
if ( not OR.StandardTermsRet.DiscountPct is nothing) then
Dim DiscountPct22238 as Double
DiscountPct22238 = OR.StandardTermsRet.DiscountPct.GetValue()
End If
End If
if (not OR.DateDrivenTermsRet. is nothing) then
'Get value of ListID
Dim ListID22239 as String
ListID22239 = OR.DateDrivenTermsRet.ListID.GetValue()
'Get value of TimeCreated
Dim TimeCreated22240 as DateTime
TimeCreated22240 = OR.DateDrivenTermsRet.TimeCreated.GetValue()
'Get value of TimeModified
Dim TimeModified22241 as DateTime
TimeModified22241 = OR.DateDrivenTermsRet.TimeModified.GetValue()
'Get value of EditSequence
Dim EditSequence22242 as String
EditSequence22242 = OR.DateDrivenTermsRet.EditSequence.GetValue()
'Get value of Name
Dim Name22243 as String
Name22243 = OR.DateDrivenTermsRet.Name.GetValue()
'Get value of IsActive
if ( not OR.DateDrivenTermsRet.IsActive is nothing) then
Dim IsActive22244 as Boolean
IsActive22244 = OR.DateDrivenTermsRet.IsActive.GetValue()
End If
'Get value of DayOfMonthDue
Dim DayOfMonthDue22245 as Integer
DayOfMonthDue22245 = OR.DateDrivenTermsRet.DayOfMonthDue.GetValue()
'Get value of DueNextMonthDays
if ( not OR.DateDrivenTermsRet.DueNextMonthDays is nothing) then
Dim DueNextMonthDays22246 as Integer
DueNextMonthDays22246 = OR.DateDrivenTermsRet.DueNextMonthDays.GetValue()
End If
'Get value of DiscountDayOfMonth
if ( not OR.DateDrivenTermsRet.DiscountDayOfMonth is nothing) then
Dim DiscountDayOfMonth22247 as Integer
DiscountDayOfMonth22247 = OR.DateDrivenTermsRet.DiscountDayOfMonth.GetValue()
End If
'Get value of DiscountPct
if ( not OR.DateDrivenTermsRet.DiscountPct is nothing) then
Dim DiscountPct22248 as Double
DiscountPct22248 = OR.DateDrivenTermsRet.DiscountPct.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 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 | //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 DoTermsQuery() { 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; BuildTermsQueryRq(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; WalkTermsQueryRs(responseMsgSet); } catch (Exception e) { MessageBox.Show(e.Message, "Error"); if (sessionBegun) { sessionManager.EndSession(); } if (connectionOpen) { sessionManager.CloseConnection(); } } } void BuildTermsQueryRq(IMsgSetRequest requestMsgSet) { ITermsQuery TermsQueryRq= requestMsgSet.AppendTermsQueryRq(); //Set attributes //Set field value for metaData TermsQueryRq.metaData.SetValue("IQBENmetaDataType"); string ORListQueryElementType22207 = "ListIDList"; if (ORListQueryElementType22207 == "ListIDList") { //Set field value for ListIDList //May create more than one of these if needed TermsQueryRq.ORListQuery.ListIDList.Add("200000-1011023419"); } if (ORListQueryElementType22207 == "FullNameList") { //Set field value for FullNameList //May create more than one of these if needed TermsQueryRq.ORListQuery.FullNameList.Add("ab"); } if (ORListQueryElementType22207 == "ListFilter") { //Set field value for MaxReturned TermsQueryRq.ORListQuery.ListFilter.MaxReturned.SetValue(6); //Set field value for ActiveStatus TermsQueryRq.ORListQuery.ListFilter.ActiveStatus.SetValue(ENActiveStatus.asActiveOnly [DEFAULT]); //Set field value for FromModifiedDate TermsQueryRq.ORListQuery.ListFilter.FromModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false); //Set field value for ToModifiedDate TermsQueryRq.ORListQuery.ListFilter.ToModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false); string ORNameFilterElementType22208 = "NameFilter"; if (ORNameFilterElementType22208 == "NameFilter") { //Set field value for MatchCriterion TermsQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.MatchCriterion.SetValue(ENMatchCriterion.mcStartsWith); //Set field value for Name TermsQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.Name.SetValue("ab"); } if (ORNameFilterElementType22208 == "NameRangeFilter") { //Set field value for FromName TermsQueryRq.ORListQuery.ListFilter.ORNameFilter.NameRangeFilter.FromName.SetValue("ab"); //Set field value for ToName TermsQueryRq.ORListQuery.ListFilter.ORNameFilter.NameRangeFilter.ToName.SetValue("ab"); } } //Set field value for IncludeRetElementList //May create more than one of these if needed TermsQueryRq.IncludeRetElementList.Add("ab"); } void WalkTermsQueryRs(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.rtTermsQueryRs) { //upcast to more specific type here, this is safe because we checked with response.Type check above IORTermsRetList OR = (IORTermsRetList)response.Detail; WalkOR(OR); } } } } } void WalkOR(IORTermsRetList OR) { if (OR == null) return; //Go through all the elements of IORTermsRetList if (OR.StandardTermsRet != null) { //Get value of ListID string ListID22209 = (string)OR.StandardTermsRet.ListID.GetValue(); //Get value of TimeCreated DateTime TimeCreated22210 = (DateTime)OR.StandardTermsRet.TimeCreated.GetValue(); //Get value of TimeModified DateTime TimeModified22211 = (DateTime)OR.StandardTermsRet.TimeModified.GetValue(); //Get value of EditSequence string EditSequence22212 = (string)OR.StandardTermsRet.EditSequence.GetValue(); //Get value of Name string Name22213 = (string)OR.StandardTermsRet.Name.GetValue(); //Get value of IsActive if (OR.StandardTermsRet.IsActive != null) { bool IsActive22214 = (bool)OR.StandardTermsRet.IsActive.GetValue(); } //Get value of StdDueDays if (OR.StandardTermsRet.StdDueDays != null) { int StdDueDays22215 = (int)OR.StandardTermsRet.StdDueDays.GetValue(); } //Get value of StdDiscountDays if (OR.StandardTermsRet.StdDiscountDays != null) { int StdDiscountDays22216 = (int)OR.StandardTermsRet.StdDiscountDays.GetValue(); } //Get value of DiscountPct if (OR.StandardTermsRet.DiscountPct != null) { double DiscountPct22217 = (double)OR.StandardTermsRet.DiscountPct.GetValue(); } } if (OR.DateDrivenTermsRet != null) { //Get value of ListID string ListID22218 = (string)OR.DateDrivenTermsRet.ListID.GetValue(); //Get value of TimeCreated DateTime TimeCreated22219 = (DateTime)OR.DateDrivenTermsRet.TimeCreated.GetValue(); //Get value of TimeModified DateTime TimeModified22220 = (DateTime)OR.DateDrivenTermsRet.TimeModified.GetValue(); //Get value of EditSequence string EditSequence22221 = (string)OR.DateDrivenTermsRet.EditSequence.GetValue(); //Get value of Name string Name22222 = (string)OR.DateDrivenTermsRet.Name.GetValue(); //Get value of IsActive if (OR.DateDrivenTermsRet.IsActive != null) { bool IsActive22223 = (bool)OR.DateDrivenTermsRet.IsActive.GetValue(); } //Get value of DayOfMonthDue int DayOfMonthDue22224 = (int)OR.DateDrivenTermsRet.DayOfMonthDue.GetValue(); //Get value of DueNextMonthDays if (OR.DateDrivenTermsRet.DueNextMonthDays != null) { int DueNextMonthDays22225 = (int)OR.DateDrivenTermsRet.DueNextMonthDays.GetValue(); } //Get value of DiscountDayOfMonth if (OR.DateDrivenTermsRet.DiscountDayOfMonth != null) { int DiscountDayOfMonth22226 = (int)OR.DateDrivenTermsRet.DiscountDayOfMonth.GetValue(); } //Get value of DiscountPct if (OR.DateDrivenTermsRet.DiscountPct != null) { double DiscountPct22227 = (double)OR.DateDrivenTermsRet.DiscountPct.GetValue(); } } } } } |