DataExtDefQuery(2.0)

Queries for the specified data extension defintion or set of definitions.


Request

Response

XMLOps

VB.NET

C#

Tag Type Max length Implementation Required

IDataExtDefQuery

Queries for the specified data extension defintion or set of definitions.
     2.0  

metaData

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

ORDataExtDefQuery

 IORDataExtDefQuery      

OwnerIDList

Zero or more OwnerID values. OwnerID refers to the owner of a data extension:If OwnerID is 0, this is a public data extension, also known as a custom field. Custom fields appear in the QuickBooks UI.If OwnerID is a GUID, for example {6B063959-81B0-4622-85D6-F548C8CCB517}, this field is a private data extension defined by an integrated application. Private data extensions do not appear in the QuickBooks UI. Note that OwnerID values are not case-sensitive, meaning that if you enter an OwnerID value with lower-case letters, the value will be saved and returned with upper-case letters. When you share a private data extension with another application, the other application must know both the OwnerID and the DataExtName, as these together form a data extension’s unique name.
 IGUIDList      

AssignToObjectList

A list of AssignToObject enum values. If this is a private data extension definition (the OwnerID value is a non-zero GUID), then AssignToObject is optional and any of the enumerated objects listed below can be specified for AssignToObject. If this is a custom field definition (the OwnerID value is 0), then AssignToObject is required. If this data ext definition is for a custom field, then only Customer, Employee, Vendor, or Item can be specified in AssignToObject. Notice that assigning to Customer or Item results in automatic propagation (assigning) to the following objects, where the custom field is available at the transaction level or transaction line item level: CreditMemo Estimate Invoice PurchaseOrder (only if AssigntoObject is set to Item) SalesOrderSalesReceipt
 IENAssignToObjectList      

IncludeRetElementList

You use this if you want to limit the data that will be returned in the response. In this list, you specify the name of each top-level element or aggregate that you want to be returned in the response to the request. You cannot specify fields within an aggregate, for example, you cannot specify a City within an Address: you must specify Address and will get the entire address. The names specified in the list are not parsed, so you must be especially careful to supply valid names, properly cased. No error is returned in the status code if you specify an invalid name. Notice that if you want to return custom data or private data extensions, you must specify the DataExtRet element and you must supply the OwnerID set to either a value of 0 (custom data) or the GUID for the private data.
 IBSTRList 50 chars 4.0  
Tag Type Max length Implementation Required

IResponse

Queries for the specified data extension defintion or set of definitions.
     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

 IDataExtDefRetList      

(List

of IDataExtDefRet Objects)
        

OwnerID

OwnerID refers to the owner of a data extension. A value of 0 means the data extension is a custom field visible and usable within the QuickBooks UI. Any other non zero value that is a valid GUID means that the data extension is a private data extension. Usually you would keep your application’s GUID confidential to prevent other applications from accessing your data extensions. But if you want to share data extensions with another application, the applications need to use the same GUID. In this case, each application could use two GUIDs, one for shared data extensions and one for confidential data extensions. (An application can have any number of GUIDs.) When you share a data extension with another application, the other application must know both the OwnerID and the DataExtName, as these together form a data extension’s unique name.
 IQBGUIDType      

DataExtID

The ID of the data extension.
 IQBIntType   11.0 Y

DataExtName

The name of the data extension. If this is a custom field, DataExtName will be visible as a label in the QuickBooks user interface. Also because OwnerID and DataExtName together make the data extension unique, and because custom fields all have the same OwnerID of zero, the DataExtName must be a unique value among existing custom fields. In contrast, the DataExtName for private data extensions must be unique only for the specified OwnerID GUID.
 IQBStringType 31 chars   Y

DataExtType

The field’s data type, which corresponds to a qbXML data type. In an IDataExtDefAdd request object, if this is a custom field, DataExtType must be detSTR255TYPE.
 IQBENDataExtTypeType     Y

AssignToObjectList

A list of AssignToObject enum values. If this is a private data extension definition (the OwnerID value is a non-zero GUID), then AssignToObject is optional and any of the enumerated objects listed below can be specified for AssignToObject. If this is a custom field definition (the OwnerID value is 0), then AssignToObject is required. If this data ext definition is for a custom field, then only Customer, Employee, Vendor, or Item can be specified in AssignToObject. Notice that assigning to Customer or Item results in automatic propagation (assigning) to the following objects, where the custom field is available at the transaction level or transaction line item level: CreditMemo Estimate Invoice PurchaseOrder (only if AssigntoObject is set to Item) SalesOrderSalesReceipt
 IENAssignToObjectList      

DataExtListRequire

If DataExtListRequire is true, this data extension field is required to be entered in lists. The default value is false.
 IQBBoolType   11.0 Y

DataExtTxnRequire

If DataExtTxnRequire is true, this data extension field is required to be entered in transaction. The default value is false.
 IQBBoolType   11.0 Y

DataExtFormatString

The string format required for the data extension.
 IQBStringType   11.0 Y 

 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
<?xml version="1.0" encoding="utf-8"?>
<?qbxml version="16.0"?>
<QBXML>
        <QBXMLMsgsRq onError="stopOnError">
                <DataExtDefQueryRq metaData="ENUMTYPE">
                        <!-- BEGIN OR -->
                                <OwnerID >GUIDTYPE</OwnerID> <!-- optional, may repeat -->
                        <!-- OR -->
                                <!-- AssignToObject may have one of the following values: Account, ARRefundCreditCard, Bill, BillPaymentCheck, BillPaymentCreditCard, BuildAssembly, Charge, Check, Company, CreditCardCharge, CreditCardCredit, CreditMemo, Customer, Deposit, Employee, Estimate, InventoryAdjustment, Invoice, Item, ItemReceipt, JournalEntry, OtherName, PurchaseOrder, ReceivePayment, SalesOrder, SalesReceipt, SalesTaxPaymentCheck, Vendor, VendorCredit -->
                                <AssignToObject >ENUMTYPE</AssignToObject> <!-- optional, may repeat -->
                        <!-- END OR -->
                        <IncludeRetElement >STRTYPE</IncludeRetElement> <!-- optional, may repeat -->
                </DataExtDefQueryRq>

                <DataExtDefQueryRs statusCode="INTTYPE" statusSeverity="STRTYPE" statusMessage="STRTYPE" retCount="INTTYPE">
                        <DataExtDefRet> <!-- optional, may repeat -->
                                <OwnerID >GUIDTYPE</OwnerID> <!-- optional -->
                                <DataExtID >INTTYPE</DataExtID> <!-- required -->
                                <DataExtName >STRTYPE</DataExtName> <!-- required -->
                                <!-- DataExtType may have one of the following values: AMTTYPE, DATETIMETYPE, INTTYPE, PERCENTTYPE, PRICETYPE, QUANTYPE, STR1024TYPE, STR255TYPE -->
                                <DataExtType >ENUMTYPE</DataExtType> <!-- required -->
                                <!-- AssignToObject may have one of the following values: Account, ARRefundCreditCard, Bill, BillPaymentCheck, BillPaymentCreditCard, BuildAssembly, Charge, Check, Company, CreditCardCharge, CreditCardCredit, CreditMemo, Customer, Deposit, Employee, Estimate, InventoryAdjustment, Invoice, Item, ItemReceipt, JournalEntry, OtherName, PurchaseOrder, ReceivePayment, SalesOrder, SalesReceipt, SalesTaxPaymentCheck, Vendor, VendorCredit -->
                                <AssignToObject >ENUMTYPE</AssignToObject> <!-- optional, may repeat -->
                                <DataExtListRequire >BOOLTYPE</DataExtListRequire> <!-- required -->
                                <DataExtTxnRequire >BOOLTYPE</DataExtTxnRequire> <!-- required -->
                                <DataExtFormatString >STRTYPE</DataExtFormatString> <!-- required -->
                        </DataExtDefRet>
                </DataExtDefQueryRs>
        </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
'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  DoDataExtDefQuery()
                        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

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

                                WalkDataExtDefQueryRs(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 BuildDataExtDefQueryRq(requestMsgSet as IMsgSetRequest)
                        Dim DataExtDefQueryRq as IDataExtDefQuery
                        DataExtDefQueryRq= requestMsgSet.AppendDataExtDefQueryRq()
                        Dim ORDataExtDefQueryElementType7872 as String
                        ORDataExtDefQueryElementType7872 = "OwnerIDList"
                        if (ORDataExtDefQueryElementType7872 == "OwnerIDList") then
                                'Set field value for OwnerIDList
                                'May create more than one of these if needed
                                DataExtDefQueryRq.ORDataExtDefQuery.OwnerIDList.Add(System.Guid.NewGuid().ToString())
                        End If
                        if (ORDataExtDefQueryElementType7872 == "AssignToObjectList") then
                                'Set field value for AssignToObjectList
                                'May create more than one of these if needed
                                DataExtDefQueryRq.ORDataExtDefQuery.AssignToObjectList.Add(ENAssignToObjectList.atolAccount)
                        End If
                        'Set field value for IncludeRetElementList
                        'May create more than one of these if needed
                        DataExtDefQueryRq.IncludeRetElementList.Add("ab")
                End Sub




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




                Public Sub WalkDataExtDefRet(DataExtDefRet as IDataExtDefRetList)
                        if (DataExtDefRet is nothing) then
                                Exit Sub
                        End If

                        'Go through all the elements of IDataExtDefRetList
                        'Get value of OwnerID
                        if ( not DataExtDefRet.OwnerID is nothing) then
                                Dim OwnerID7873 as String
                                OwnerID7873 = DataExtDefRet.OwnerID.GetValue()
                        End If
                        'Get value of DataExtID
                        Dim DataExtID7874 as Integer
                        DataExtID7874 = DataExtDefRet.DataExtID.GetValue()
                        'Get value of DataExtName
                        Dim DataExtName7875 as String
                        DataExtName7875 = DataExtDefRet.DataExtName.GetValue()
                        'Get value of DataExtType
                        Dim DataExtType7876 as ENDataExtType
                        DataExtType7876 = DataExtDefRet.DataExtType.GetValue()
                        'Get value of AssignToObjectList
                        if ( not DataExtDefRet.AssignToObjectList is nothing) then
                                Dim AssignToObject7877 as ENAssignToObjectList
                                AssignToObject7877 = DataExtDefRet.AssignToObjectList.GetValue()
                        End If
                        'Get value of DataExtListRequire
                        Dim DataExtListRequire7878 as Boolean
                        DataExtListRequire7878 = DataExtDefRet.DataExtListRequire.GetValue()
                        'Get value of DataExtTxnRequire
                        Dim DataExtTxnRequire7879 as Boolean
                        DataExtTxnRequire7879 = DataExtDefRet.DataExtTxnRequire.GetValue()
                        'Get value of DataExtFormatString
                        Dim DataExtFormatString7880 as String
                        DataExtFormatString7880 = DataExtDefRet.DataExtFormatString.GetValue()
                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
//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  DoDataExtDefQuery()
                {
                        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;

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

                                WalkDataExtDefQueryRs(responseMsgSet);
                        }
                        catch (Exception e)
                        {
                                MessageBox.Show(e.Message, "Error");
                                if (sessionBegun)
                                {
                                        sessionManager.EndSession();
                                }
                                if (connectionOpen)
                                {
                                        sessionManager.CloseConnection();
                                }
                        }
                }
                void BuildDataExtDefQueryRq(IMsgSetRequest requestMsgSet)
                {
                        IDataExtDefQuery DataExtDefQueryRq= requestMsgSet.AppendDataExtDefQueryRq();
                        //Set attributes
                        //Set field value for metaData
                        DataExtDefQueryRq.metaData.SetValue("IQBENmetaDataType");
                        string ORDataExtDefQueryElementType7863 = "OwnerIDList";
                        if (ORDataExtDefQueryElementType7863 == "OwnerIDList")
                        {
                                //Set field value for OwnerIDList
                                //May create more than one of these if needed
                                DataExtDefQueryRq.ORDataExtDefQuery.OwnerIDList.Add(Guid.NewGuid().ToString());
                        }
                        if (ORDataExtDefQueryElementType7863 == "AssignToObjectList")
                        {
                                //Set field value for AssignToObjectList
                                //May create more than one of these if needed
                                DataExtDefQueryRq.ORDataExtDefQuery.AssignToObjectList.Add(ENAssignToObjectList.atolAccount);
                        }
                        //Set field value for IncludeRetElementList
                        //May create more than one of these if needed
                        DataExtDefQueryRq.IncludeRetElementList.Add("ab");
                }




                void WalkDataExtDefQueryRs(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.rtDataExtDefQueryRs)
                                                {
                                                        //upcast to more specific type here, this is safe because we checked with response.Type check above
                                                        IDataExtDefRetList DataExtDefRet = (IDataExtDefRetList)response.Detail;
                                                        WalkDataExtDefRet(DataExtDefRet);
                                                }
                                        }
                                }
                        }
                }




                void WalkDataExtDefRet(IDataExtDefRetList DataExtDefRet)
                {
                        if (DataExtDefRet == null) return;
                        //Go through all the elements of IDataExtDefRetList
                        //Get value of OwnerID
                        if (DataExtDefRet.OwnerID != null)
                        {
                                string OwnerID7864 = (string)DataExtDefRet.OwnerID.GetValue();
                        }
                        //Get value of DataExtID
                        int DataExtID7865 = (int)DataExtDefRet.DataExtID.GetValue();
                        //Get value of DataExtName
                        string DataExtName7866 = (string)DataExtDefRet.DataExtName.GetValue();
                        //Get value of DataExtType
                        ENDataExtType DataExtType7867 = (ENDataExtType)DataExtDefRet.DataExtType.GetValue();
                        //Get value of AssignToObjectList
                        if (DataExtDefRet.AssignToObjectList != null)
                        {
                                ENAssignToObjectList AssignToObject7868 = (ENAssignToObjectList)DataExtDefRet.AssignToObjectList.GetValue();
                        }
                        //Get value of DataExtListRequire
                        bool DataExtListRequire7869 = (bool)DataExtDefRet.DataExtListRequire.GetValue();
                        //Get value of DataExtTxnRequire
                        bool DataExtTxnRequire7870 = (bool)DataExtDefRet.DataExtTxnRequire.GetValue();
                        //Get value of DataExtFormatString
                        string DataExtFormatString7871 = (string)DataExtDefRet.DataExtFormatString.GetValue();
                }




        }
}