ListDeletedQuery

Returns the objects that were deleted from the QBPOS company, that match the specified object type (customer, vendor, etc.), optionally within the specified time frame.


Request

Response

XMLOPS

VB.NET

C#

Tag Type Max length Implementation Required

IListDeletedQuery

Returns the objects that were deleted from the QBPOS company, that match the specified object type (customer, vendor, etc.), optionally within the specified time frame.
     2.0  

ListDelType

The type of list from which a list member is being deleted or has been deleted.
 IQBENListDelTypeType     Y

DeletedDateRangeFilter

The time frame within which to search for the deleted objects.
 IDeletedDateRangeFilter      

FromDeletedDate

The start of the date range to be searched for deleted objects.
 IQBDateTimeType      

ToDeletedDate

End of the date range to be searched for deleted objects.
 IQBDateTimeType      
Tag Type Max length Implementation Required

IResponse

Returns the objects that were deleted from the QBPOS company, that match the specified object type (customer, vendor, etc.), optionally within the specified time frame.
     2.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|us.png| Y

Detail

 IListDeletedRetList      

(List of IListDeletedRet Objects)

        

ListDelType

The type of list from which a list member is being deleted or has been deleted.
 IQBENListDelTypeType      

ListID

The unique ID returned by QBPOS for this object. If supplied in a request, the ListID is a reference to an object required in the request. For example, in a SalesOrder or PurchaseOrder line item, the ListID that is required is an Item list ID.
 IQBIDType      

TimeCreated

The timestamp indicating the time when this object was created in QBPOS.
 IQBDateTimeType      

TimeDeleted

Timestamp marking the date/time when QBPOS successfully deleted the object.
 IQBDateTimeType       

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
<?xml version="1.0" encoding="utf-8"?>
<?qbposxml version="4.0"?>
<QBPOSXML>
        <QBPOSXMLMsgsRq onError="stopOnError">
                <ListDeletedQueryRq>
                        <!-- ListDelType may have one of the following values: Department, Customer, Vendor, Employee, ItemInventory, SalesOrder, PurchaseOrder, TimeEntry, TaxCategory, TaxCode, HeldSalesReceipt, HeldVoucher, HeldInventoryQtyAdjustment, HeldInventoryCostAdjustment, HeldTransferSlip -->
                        <ListDelType >ENUMTYPE</ListDelType> <!-- required -->
                        <DeletedDateRangeFilter> <!-- optional -->
                                <FromDeletedDate >DATETIMETYPE</FromDeletedDate> <!-- optional -->
                                <ToDeletedDate >DATETIMETYPE</ToDeletedDate> <!-- optional -->
                        </DeletedDateRangeFilter>
                </ListDeletedQueryRq>

                <ListDeletedQueryRs statusCode="INTTYPE" statusSeverity="STRTYPE" statusMessage="STRTYPE" retCount="INTTYPE">
                        <ListDeletedRet> <!-- optional, may repeat -->
                                <!-- ListDelType may have one of the following values: Department, Customer, Vendor, Employee, ItemInventory, SalesOrder, PurchaseOrder, TimeEntry, TaxCategory, TaxCode, HeldSalesReceipt, HeldVoucher, HeldInventoryQtyAdjustment, HeldInventoryCostAdjustment, HeldTransferSlip -->
                                <ListDelType >ENUMTYPE</ListDelType> <!-- optional -->
                                <ListID >IDTYPE</ListID> <!-- optional -->
                                <TimeCreated >DATETIMETYPE</TimeCreated> <!-- optional -->
                                <TimeDeleted >DATETIMETYPE</TimeDeleted> <!-- optional -->
                        </ListDeletedRet>
                </ListDeletedQueryRs>
        </QBPOSXMLMsgsRq>
</QBPOSXML>


  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
'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.qbposfc4

        Public Class SampleListDeletedQuery
                Public Sub  DoListDeletedQuery()
                        Dim sessionBegun as Boolean
                        sessionBegun = False
                        Dim connectionOpen as Boolean
                        connectionOpen = False
                        Dim sessionManager as QBPOSSessionManager
                        sessionManager = nothing

                        Try
                                'Create the session Manager object
                                sessionManager = new QBPOSSessionManager

                                'Create the message set request object to hold our request
                                Dim requestMsgSet as IMsgSetRequest
                                requestMsgSet = sessionManager.CreateMsgSetRequest(4,0)
                                requestMsgSet.Attributes.OnError = ENRqOnError.roeContinue

                                BuildListDeletedQueryRq(requestMsgSet)

                                'Connect to QuickBooks and begin a session
                                sessionManager.OpenConnection("","Sample Code from OSR")
                                connectionOpen = True
                                sessionManager.BeginSession("")
                                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

                                WalkListDeletedQueryRs(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 BuildListDeletedQueryRq(requestMsgSet as IMsgSetRequest)
                        Dim ListDeletedQueryRq as IListDeletedQuery
                        ListDeletedQueryRq= requestMsgSet.AppendListDeletedQueryRq()
                        'Set field value for ListDelType
                        ListDeletedQueryRq.ListDelType.SetValue(ENListDelType.ldtDepartment)
                        'Set field value for FromDeletedDate
                        ListDeletedQueryRq.DeletedDateRangeFilter.FromDeletedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false)
                        'Set field value for ToDeletedDate
                        ListDeletedQueryRq.DeletedDateRangeFilter.ToDeletedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false)
                End Sub




                Public Sub WalkListDeletedQueryRs( 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.rtListDeletedQueryRs) then
                                                        'upcast to more specific type here, this is safe because we checked with response.Type check above
                                                        Dim ListDeletedRet as IListDeletedRetList
                                                        ListDeletedRet = CType(response.Detail,IListDeletedRetList)
                                                        for z=0 to ListDeletedRet.Count-1
                                                                WalkListDeletedRet(ListDeletedRet.GetAt(z))
                                                        Next z
                                                End If
                                        End If
                                End If
                        Next j
                End Sub




                Public Sub WalkListDeletedRet(ListDeletedRet as IListDeletedRet)
                        if (ListDeletedRet is nothing) then
                                Exit Sub
                        End If

                        'Go through all the elements of IListDeletedRetList
                        'Get value of ListDelType
                        if ( not ListDeletedRet.ListDelType is nothing) then
                                Dim ListDelType2277 as ENListDelType
                                ListDelType2277 = ListDeletedRet.ListDelType.GetValue()
                        End If
                        'Get value of ListID
                        if ( not ListDeletedRet.ListID is nothing) then
                                Dim ListID2278 as String
                                ListID2278 = ListDeletedRet.ListID.GetValue()
                        End If
                        'Get value of TimeCreated
                        if ( not ListDeletedRet.TimeCreated is nothing) then
                                Dim TimeCreated2279 as DateTime
                                TimeCreated2279 = ListDeletedRet.TimeCreated.GetValue()
                        End If
                        'Get value of TimeDeleted
                        if ( not ListDeletedRet.TimeDeleted is nothing) then
                                Dim TimeDeleted2280 as DateTime
                                TimeDeleted2280 = ListDeletedRet.TimeDeleted.GetValue()
                        End If
                End Sub




        End Class


  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
//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.qbposfc4;

namespace com.intuit.idn.samples
{
        public class SampleListDeletedQuery
        {
                public void  DoListDeletedQuery()
                {
                        bool sessionBegun = false;
                        bool connectionOpen = false;
                        QBPOSSessionManager sessionManager = null;

                        try
                        {
                                //Create the session Manager object
                                sessionManager = new QBPOSSessionManager();

                                //Create the message set request object to hold our request
                                IMsgSetRequest requestMsgSet = sessionManager.CreateMsgSetRequest(4,0);
                                requestMsgSet.Attributes.OnError = ENRqOnError.roeContinue;

                                BuildListDeletedQueryRq(requestMsgSet);

                                //Connect to QuickBooks and begin a session
                                sessionManager.OpenConnection("","Sample Code from OSR");
                                connectionOpen = true;
                                sessionManager.BeginSession("");
                                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;

                                WalkListDeletedQueryRs(responseMsgSet);
                        }
                        catch (Exception e)
                        {
                                MessageBox.Show(e.Message, "Error");
                                if (sessionBegun)
                                {
                                        sessionManager.EndSession();
                                }
                                if (connectionOpen)
                                {
                                        sessionManager.CloseConnection();
                                }
                        }
                }
                void BuildListDeletedQueryRq(IMsgSetRequest requestMsgSet)
                {
                        IListDeletedQuery ListDeletedQueryRq= requestMsgSet.AppendListDeletedQueryRq();
                        //Set field value for ListDelType
                        ListDeletedQueryRq.ListDelType.SetValue(ENListDelType.ldtDepartment);
                        //Set field value for FromDeletedDate
                        ListDeletedQueryRq.DeletedDateRangeFilter.FromDeletedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false);
                        //Set field value for ToDeletedDate
                        ListDeletedQueryRq.DeletedDateRangeFilter.ToDeletedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false);
                }




                void WalkListDeletedQueryRs(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.rtListDeletedQueryRs)
                                                {
                                                        //upcast to more specific type here, this is safe because we checked with response.Type check above
                                                        IListDeletedRetList ListDeletedRet = (IListDeletedRetList)response.Detail;
                                                        for(int z=0; z < ListDeletedRet.Count; z++)
                                                        {
                                                                WalkListDeletedRet(ListDeletedRet.GetAt(z));
                                                        }
                                                }
                                        }
                                }
                        }
                }




                void WalkListDeletedRet(IListDeletedRet ListDeletedRet)
                {
                        if (ListDeletedRet == null) return;
                        //Go through all the elements of IListDeletedRetList
                        //Get value of ListDelType
                        if (ListDeletedRet.ListDelType != null)
                        {
                                ENListDelType ListDelType2281 = (ENListDelType)ListDeletedRet.ListDelType.GetValue();
                        }
                        //Get value of ListID
                        if (ListDeletedRet.ListID != null)
                        {
                                string ListID2282 = (string)ListDeletedRet.ListID.GetValue();
                        }
                        //Get value of TimeCreated
                        if (ListDeletedRet.TimeCreated != null)
                        {
                                DateTime TimeCreated2283 = (DateTime)ListDeletedRet.TimeCreated.GetValue();
                        }
                        //Get value of TimeDeleted
                        if (ListDeletedRet.TimeDeleted != null)
                        {
                                DateTime TimeDeleted2284 = (DateTime)ListDeletedRet.TimeDeleted.GetValue();
                        }
                }




        }
}