ToDoQuery
A “to do”list is used in QuickBooks to keep track of tasks. Notice that the various Name filters refer to the Notes field in the ToDoQuery. So, by using these filters, you are searching the Notes.
Request
Response
XMLOps
VB.NET
C#
| Tag | Type | Max length | Implementation | Required |
|---|---|---|---|---|
IToDoQuery
A “to do”list is used in QuickBooks to keep track of tasks. Notice that the various Name filters refer to the Notes field in the ToDoQuery. So, by using these filters, you are searching the Notes.
|
||||
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  |
||
ORToDoListQuery |
IORToDoListQuery | |||
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 | |||
ToDoListFilter
The IToDoListFilter group object allows you to search for “to do” tasks based on whether they’re active, when they were last modified, their names, and whether they are marked as “done.”
|
IToDoListFilter | |||
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 | |||
DoneStatus
Selects all the relevant “to do” notes (dsAll), only those that are done (dsDoneOnly), or only those that are not done (dsNotDoneOnly).
|
IQBENDoneStatusType | |||
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
A “to do”list is used in QuickBooks to keep track of tasks. Notice that the various Name filters refer to the Notes field in the ToDoQuery. So, by using these filters, you are searching the Notes.
|
||||
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 |
IToDoRetList | |||
(List
of IToDoRet 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 | |
Notes
Additional information.
|
IQBStringType | 4095 chars | Y | |
IsActive
If IsActive is true, this object is currently enabled for use by QuickBooks. The default value is true.
|
IQBBoolType | |||
Type
Type may have one of the following values: Task [DEFAULT], Call, Fax, Email, Meeting, Appointment
|
IQBENTypeType | 13.0 | ||
Priority
Priority may have one of the following values: Low [DEFAULT], Medium, High
|
IQBENPriorityType | 13.0 | ||
ORListRef |
IORListRef | 13.0 | ||
CustomerRef
The customer list includes information about the QuickBooks user’s customers and the individual jobs that are being performed for them. A CustomerRef aggregate refers to one of the customers (or customer jobs) on the list. In a request, if a CustomerRef aggregate includes both FullName and ListID, FullName will be ignored. Special cases to note:In SalesReceipt and ReceivePayment requests, CustomerRef refers to the customer or customer job to which the payment is credited.In a TimeTracking request, CustomerRef refers to the customer or customer job to which this time could be billed. If IsBillable is set to true, CustomerRef is required in TimeTrackingAdd. In an ExpenseLineAdd request, if AccountRef refers to an A/P account, CustomerRef must refer to a vendor (not to a customer). If AccountRef refers to any other type of account, the CustomerRef must refer to a customer.
|
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 | 209 chars | ||
EmployeeRef
The employee list contains payroll information about each of the company’s employees.
|
IQBBaseRef | |||
ListID
Along with FullName, ListID is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a ListID. A ListID is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same ListID, and a customer could not have the same ListID as an employee (because Customer and Employee are both name lists). But a customer could have the same ListID as a non-inventory item.
|
IQBIDType | |||
FullName
FullName (along with ListID) is a way to identify a list object. The FullName is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. FullName values are not case-sensitive.
|
IQBStringType | 31 chars | ||
LeadRef
The lead list contains information about leads for a company.
|
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 | 209 chars | ||
VendorRef
A vendor is any person or company from whom a small business owner buys goods and services. (Banks and tax agencies usually are included on the vendor list.) A company’s vendor list contains information such as account balance and contact information about each vendor. A VendorRef aggregate refers to one of the vendors on the list. In a request, if a VendorRef 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 | 41 chars | ||
IsDone
If IsDone is true, this “to do” task has been completed. The default value of IsDone is false.
|
IQBBoolType | Y | ||
ReminderDate
The date on which the contents of the Notes string will appear on the Reminder list within QuickBooks.
|
IQBDateType | Y | ||
ReminderTime
The time on which the contents of the Notes string will appear on the Reminder list within QuickBooks.
|
IQBTimeIntervalType | 13.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 | <?xml version="1.0" encoding="utf-8"?> <?qbxml version="17.0"?> <QBXML> <QBXMLMsgsRq onError="stopOnError"> <ToDoQueryRq metaData="ENUMTYPE"> <!-- BEGIN OR --> <ListID >IDTYPE</ListID> <!-- 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 --> <!-- DoneStatus may have one of the following values: NotDoneOnly [DEFAULT], DoneOnly, All --> <DoneStatus >ENUMTYPE</DoneStatus> <!-- optional --> <!-- END OR --> <IncludeRetElement >STRTYPE</IncludeRetElement> <!-- optional, may repeat --> </ToDoQueryRq> <ToDoQueryRs statusCode="INTTYPE" statusSeverity="STRTYPE" statusMessage="STRTYPE" retCount="INTTYPE"> <ToDoRet> <!-- optional, may repeat --> <ListID >IDTYPE</ListID> <!-- required --> <TimeCreated >DATETIMETYPE</TimeCreated> <!-- required --> <TimeModified >DATETIMETYPE</TimeModified> <!-- required --> <EditSequence >STRTYPE</EditSequence> <!-- required --> <Notes >STRTYPE</Notes> <!-- required --> <IsActive >BOOLTYPE</IsActive> <!-- optional --> <!-- Type may have one of the following values: Task [DEFAULT], Call, Fax, Email, Meeting, Appointment --> <Type >ENUMTYPE</Type> <!-- optional --> <!-- Priority may have one of the following values: Low [DEFAULT], Medium, High --> <Priority >ENUMTYPE</Priority> <!-- optional --> <!-- BEGIN OR --> <CustomerRef> <!-- optional --> <ListID >IDTYPE</ListID> <!-- optional --> <FullName >STRTYPE</FullName> <!-- optional --> </CustomerRef> <!-- OR --> <EmployeeRef> <!-- optional --> <ListID >IDTYPE</ListID> <!-- optional --> <FullName >STRTYPE</FullName> <!-- optional --> </EmployeeRef> <!-- OR --> <LeadRef> <!-- optional --> <ListID >IDTYPE</ListID> <!-- optional --> <FullName >STRTYPE</FullName> <!-- optional --> </LeadRef> <!-- OR --> <VendorRef> <!-- optional --> <ListID >IDTYPE</ListID> <!-- optional --> <FullName >STRTYPE</FullName> <!-- optional --> </VendorRef> <!-- END OR --> <IsDone >BOOLTYPE</IsDone> <!-- required --> <ReminderDate >DATETYPE</ReminderDate> <!-- required --> <ReminderTime >TIMEINTERVALTYPE</ReminderTime> <!-- optional --> </ToDoRet> </ToDoQueryRs> </QBXMLMsgsRq> </QBXML> |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 | '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 DoToDoQuery()
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
BuildToDoQueryRq(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
WalkToDoQueryRs(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 BuildToDoQueryRq(requestMsgSet as IMsgSetRequest)
Dim ToDoQueryRq as IToDoQuery
ToDoQueryRq= requestMsgSet.AppendToDoQueryRq()
Dim ORToDoListQueryElementType22531 as String
ORToDoListQueryElementType22531 = "ListIDList"
if (ORToDoListQueryElementType22531 == "ListIDList") then
'Set field value for ListIDList
'May create more than one of these if needed
ToDoQueryRq.ORToDoListQuery.ListIDList.Add("200000-1011023419")
End If
if (ORToDoListQueryElementType22531 == "ToDoListFilter") then
'Set field value for MaxReturned
ToDoQueryRq.ORToDoListQuery.ToDoListFilter.MaxReturned.SetValue(6)
'Set field value for ActiveStatus
ToDoQueryRq.ORToDoListQuery.ToDoListFilter.ActiveStatus.SetValue(ENActiveStatus.asActiveOnly [DEFAULT])
'Set field value for FromModifiedDate
ToDoQueryRq.ORToDoListQuery.ToDoListFilter.FromModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false)
'Set field value for ToModifiedDate
ToDoQueryRq.ORToDoListQuery.ToDoListFilter.ToModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false)
Dim ORNameFilterElementType22532 as String
ORNameFilterElementType22532 = "NameFilter"
if (ORNameFilterElementType22532 == "NameFilter") then
'Set field value for MatchCriterion
ToDoQueryRq.ORToDoListQuery.ToDoListFilter.ORNameFilter.NameFilter.MatchCriterion.SetValue(ENMatchCriterion.mcStartsWith)
'Set field value for Name
ToDoQueryRq.ORToDoListQuery.ToDoListFilter.ORNameFilter.NameFilter.Name.SetValue("ab")
End If
if (ORNameFilterElementType22532 == "NameRangeFilter") then
'Set field value for FromName
ToDoQueryRq.ORToDoListQuery.ToDoListFilter.ORNameFilter.NameRangeFilter.FromName.SetValue("ab")
'Set field value for ToName
ToDoQueryRq.ORToDoListQuery.ToDoListFilter.ORNameFilter.NameRangeFilter.ToName.SetValue("ab")
End If
'Set field value for DoneStatus
ToDoQueryRq.ORToDoListQuery.ToDoListFilter.DoneStatus.SetValue(ENDoneStatus.dsNotDoneOnly [DEFAULT])
End If
'Set field value for IncludeRetElementList
'May create more than one of these if needed
ToDoQueryRq.IncludeRetElementList.Add("ab")
End Sub
Public Sub WalkToDoQueryRs( 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.rtToDoQueryRs) then
'upcast to more specific type here, this is safe because we checked with response.Type check above
Dim ToDoRet as IToDoRetList
ToDoRet = CType(response.Detail,IToDoRetList)
WalkToDoRet(ToDoRet)
End If
End If
End If
Next j
End Sub
Public Sub WalkToDoRet(ToDoRet as IToDoRetList)
if (ToDoRet is nothing) then
Exit Sub
End If
'Go through all the elements of IToDoRetList
'Get value of ListID
Dim ListID22533 as String
ListID22533 = ToDoRet.ListID.GetValue()
'Get value of TimeCreated
Dim TimeCreated22534 as DateTime
TimeCreated22534 = ToDoRet.TimeCreated.GetValue()
'Get value of TimeModified
Dim TimeModified22535 as DateTime
TimeModified22535 = ToDoRet.TimeModified.GetValue()
'Get value of EditSequence
Dim EditSequence22536 as String
EditSequence22536 = ToDoRet.EditSequence.GetValue()
'Get value of Notes
Dim Notes22537 as String
Notes22537 = ToDoRet.Notes.GetValue()
'Get value of IsActive
if ( not ToDoRet.IsActive is nothing) then
Dim IsActive22538 as Boolean
IsActive22538 = ToDoRet.IsActive.GetValue()
End If
'Get value of Type
if ( not ToDoRet.Type is nothing) then
Dim Type22539 as ENType
Type22539 = ToDoRet.Type.GetValue()
End If
'Get value of Priority
if ( not ToDoRet.Priority is nothing) then
Dim Priority22540 as ENPriority
Priority22540 = ToDoRet.Priority.GetValue()
End If
if (not ToDoRet.ORListRef is nothing) then
if (not ToDoRet.ORListRef.CustomerRef is nothing) then
if (not ToDoRet.ORListRef.CustomerRef. is nothing) then
'Get value of ListID
if ( not ToDoRet.ORListRef.CustomerRef.ListID is nothing) then
Dim ListID22542 as String
ListID22542 = ToDoRet.ORListRef.CustomerRef.ListID.GetValue()
End If
'Get value of FullName
if ( not ToDoRet.ORListRef.CustomerRef.FullName is nothing) then
Dim FullName22543 as String
FullName22543 = ToDoRet.ORListRef.CustomerRef.FullName.GetValue()
End If
End If
End If
if (not ToDoRet.ORListRef.EmployeeRef is nothing) then
if (not ToDoRet.ORListRef.EmployeeRef. is nothing) then
'Get value of ListID
if ( not ToDoRet.ORListRef.EmployeeRef.ListID is nothing) then
Dim ListID22544 as String
ListID22544 = ToDoRet.ORListRef.EmployeeRef.ListID.GetValue()
End If
'Get value of FullName
if ( not ToDoRet.ORListRef.EmployeeRef.FullName is nothing) then
Dim FullName22545 as String
FullName22545 = ToDoRet.ORListRef.EmployeeRef.FullName.GetValue()
End If
End If
End If
if (not ToDoRet.ORListRef.LeadRef is nothing) then
if (not ToDoRet.ORListRef.LeadRef. is nothing) then
'Get value of ListID
if ( not ToDoRet.ORListRef.LeadRef.ListID is nothing) then
Dim ListID22546 as String
ListID22546 = ToDoRet.ORListRef.LeadRef.ListID.GetValue()
End If
'Get value of FullName
if ( not ToDoRet.ORListRef.LeadRef.FullName is nothing) then
Dim FullName22547 as String
FullName22547 = ToDoRet.ORListRef.LeadRef.FullName.GetValue()
End If
End If
End If
if (not ToDoRet.ORListRef.VendorRef is nothing) then
if (not ToDoRet.ORListRef.VendorRef. is nothing) then
'Get value of ListID
if ( not ToDoRet.ORListRef.VendorRef.ListID is nothing) then
Dim ListID22548 as String
ListID22548 = ToDoRet.ORListRef.VendorRef.ListID.GetValue()
End If
'Get value of FullName
if ( not ToDoRet.ORListRef.VendorRef.FullName is nothing) then
Dim FullName22549 as String
FullName22549 = ToDoRet.ORListRef.VendorRef.FullName.GetValue()
End If
End If
End If
End If
'Get value of IsDone
Dim IsDone22550 as Boolean
IsDone22550 = ToDoRet.IsDone.GetValue()
'Get value of ReminderDate
Dim ReminderDate22551 as DateTime
ReminderDate22551 = ToDoRet.ReminderDate.GetValue()
'Get value of ReminderTime
if ( not ToDoRet.ReminderTime is nothing) then
Dim ReminderTime22552 as IQBTimeIntervalType
ReminderTime22552 = ToDoRet.ReminderTime.GetValue()
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 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 | //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 DoToDoQuery() { 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; BuildToDoQueryRq(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; WalkToDoQueryRs(responseMsgSet); } catch (Exception e) { MessageBox.Show(e.Message, "Error"); if (sessionBegun) { sessionManager.EndSession(); } if (connectionOpen) { sessionManager.CloseConnection(); } } } void BuildToDoQueryRq(IMsgSetRequest requestMsgSet) { IToDoQuery ToDoQueryRq= requestMsgSet.AppendToDoQueryRq(); //Set attributes //Set field value for metaData ToDoQueryRq.metaData.SetValue("IQBENmetaDataType"); string ORToDoListQueryElementType22509 = "ListIDList"; if (ORToDoListQueryElementType22509 == "ListIDList") { //Set field value for ListIDList //May create more than one of these if needed ToDoQueryRq.ORToDoListQuery.ListIDList.Add("200000-1011023419"); } if (ORToDoListQueryElementType22509 == "ToDoListFilter") { //Set field value for MaxReturned ToDoQueryRq.ORToDoListQuery.ToDoListFilter.MaxReturned.SetValue(6); //Set field value for ActiveStatus ToDoQueryRq.ORToDoListQuery.ToDoListFilter.ActiveStatus.SetValue(ENActiveStatus.asActiveOnly [DEFAULT]); //Set field value for FromModifiedDate ToDoQueryRq.ORToDoListQuery.ToDoListFilter.FromModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false); //Set field value for ToModifiedDate ToDoQueryRq.ORToDoListQuery.ToDoListFilter.ToModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false); string ORNameFilterElementType22510 = "NameFilter"; if (ORNameFilterElementType22510 == "NameFilter") { //Set field value for MatchCriterion ToDoQueryRq.ORToDoListQuery.ToDoListFilter.ORNameFilter.NameFilter.MatchCriterion.SetValue(ENMatchCriterion.mcStartsWith); //Set field value for Name ToDoQueryRq.ORToDoListQuery.ToDoListFilter.ORNameFilter.NameFilter.Name.SetValue("ab"); } if (ORNameFilterElementType22510 == "NameRangeFilter") { //Set field value for FromName ToDoQueryRq.ORToDoListQuery.ToDoListFilter.ORNameFilter.NameRangeFilter.FromName.SetValue("ab"); //Set field value for ToName ToDoQueryRq.ORToDoListQuery.ToDoListFilter.ORNameFilter.NameRangeFilter.ToName.SetValue("ab"); } //Set field value for DoneStatus ToDoQueryRq.ORToDoListQuery.ToDoListFilter.DoneStatus.SetValue(ENDoneStatus.dsNotDoneOnly [DEFAULT]); } //Set field value for IncludeRetElementList //May create more than one of these if needed ToDoQueryRq.IncludeRetElementList.Add("ab"); } void WalkToDoQueryRs(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.rtToDoQueryRs) { //upcast to more specific type here, this is safe because we checked with response.Type check above IToDoRetList ToDoRet = (IToDoRetList)response.Detail; WalkToDoRet(ToDoRet); } } } } } void WalkToDoRet(IToDoRetList ToDoRet) { if (ToDoRet == null) return; //Go through all the elements of IToDoRetList //Get value of ListID string ListID22511 = (string)ToDoRet.ListID.GetValue(); //Get value of TimeCreated DateTime TimeCreated22512 = (DateTime)ToDoRet.TimeCreated.GetValue(); //Get value of TimeModified DateTime TimeModified22513 = (DateTime)ToDoRet.TimeModified.GetValue(); //Get value of EditSequence string EditSequence22514 = (string)ToDoRet.EditSequence.GetValue(); //Get value of Notes string Notes22515 = (string)ToDoRet.Notes.GetValue(); //Get value of IsActive if (ToDoRet.IsActive != null) { bool IsActive22516 = (bool)ToDoRet.IsActive.GetValue(); } //Get value of Type if (ToDoRet.Type != null) { ENType Type22517 = (ENType)ToDoRet.Type.GetValue(); } //Get value of Priority if (ToDoRet.Priority != null) { ENPriority Priority22518 = (ENPriority)ToDoRet.Priority.GetValue(); } if (ToDoRet.ORListRef != null) { if (ToDoRet.ORListRef.CustomerRef != null) { if (ToDoRet.ORListRef.CustomerRef != null) { //Get value of ListID if (ToDoRet.ORListRef.CustomerRef.ListID != null) { string ListID22520 = (string)ToDoRet.ORListRef.CustomerRef.ListID.GetValue(); } //Get value of FullName if (ToDoRet.ORListRef.CustomerRef.FullName != null) { string FullName22521 = (string)ToDoRet.ORListRef.CustomerRef.FullName.GetValue(); } } } if (ToDoRet.ORListRef.EmployeeRef != null) { if (ToDoRet.ORListRef.EmployeeRef != null) { //Get value of ListID if (ToDoRet.ORListRef.EmployeeRef.ListID != null) { string ListID22522 = (string)ToDoRet.ORListRef.EmployeeRef.ListID.GetValue(); } //Get value of FullName if (ToDoRet.ORListRef.EmployeeRef.FullName != null) { string FullName22523 = (string)ToDoRet.ORListRef.EmployeeRef.FullName.GetValue(); } } } if (ToDoRet.ORListRef.LeadRef != null) { if (ToDoRet.ORListRef.LeadRef != null) { //Get value of ListID if (ToDoRet.ORListRef.LeadRef.ListID != null) { string ListID22524 = (string)ToDoRet.ORListRef.LeadRef.ListID.GetValue(); } //Get value of FullName if (ToDoRet.ORListRef.LeadRef.FullName != null) { string FullName22525 = (string)ToDoRet.ORListRef.LeadRef.FullName.GetValue(); } } } if (ToDoRet.ORListRef.VendorRef != null) { if (ToDoRet.ORListRef.VendorRef != null) { //Get value of ListID if (ToDoRet.ORListRef.VendorRef.ListID != null) { string ListID22526 = (string)ToDoRet.ORListRef.VendorRef.ListID.GetValue(); } //Get value of FullName if (ToDoRet.ORListRef.VendorRef.FullName != null) { string FullName22527 = (string)ToDoRet.ORListRef.VendorRef.FullName.GetValue(); } } } } //Get value of IsDone bool IsDone22528 = (bool)ToDoRet.IsDone.GetValue(); //Get value of ReminderDate DateTime ReminderDate22529 = (DateTime)ToDoRet.ReminderDate.GetValue(); //Get value of ReminderTime if (ToDoRet.ReminderTime != null) { IQBTimeIntervalType ReminderTime22530 = (IQBTimeIntervalType)ToDoRet.ReminderTime.GetValue(); } } } } |