TemplateQuery(3.0)

A template query returns the names of all templates that have been defined in QuickBooks. Templates are mainly used for specifying how to print certain transactions. The following transactions can have templates defined for them: credit memo, estimate, invoice, purchase order, sales order, sales receipt, receipt payment and bill payment customization.


Request

Response

XMLOps

VB.NET

C#

Tag Type Max length Implementation Required

ITemplateQuery

A template query returns the names of all templates that have been defined in QuickBooks. Templates are mainly used for specifying how to print certain transactions. The following transactions can have templates defined for them: credit memo, estimate, invoice, purchase order, sales order, sales receipt, receipt payment and bill payment
     3.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  

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 template query returns the names of all templates that have been defined in QuickBooks. Templates are mainly used for specifying how to print certain transactions. The following transactions can have templates defined for them: credit memo, estimate, invoice, purchase order, sales order, sales receipt, receipt payment and bill payment.
     3.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

 ITemplateRetList      

(List

of ITemplateRet 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

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      

TemplateType

The type of trasaction for which this template was defined.
 IQBENTemplateTypeType     Y 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
<?xml version="1.0" encoding="utf-8"?>
<?qbxml version="16.0"?>
<QBXML>
        <QBXMLMsgsRq onError="stopOnError">
                <TemplateQueryRq metaData="ENUMTYPE">
                        <IncludeRetElement >STRTYPE</IncludeRetElement> <!-- optional, may repeat -->
                </TemplateQueryRq>

                <TemplateQueryRs statusCode="INTTYPE" statusSeverity="STRTYPE" statusMessage="STRTYPE" retCount="INTTYPE">
                        <TemplateRet> <!-- optional, may repeat -->
                                <ListID >IDTYPE</ListID> <!-- required -->
                                <TimeCreated >DATETIMETYPE</TimeCreated> <!-- required -->
                                <TimeModified >DATETIMETYPE</TimeModified> <!-- required -->
                                <EditSequence >STRTYPE</EditSequence> <!-- required -->
                                <Name >STRTYPE</Name> <!-- required -->
                                <IsActive >BOOLTYPE</IsActive> <!-- optional -->
                                <!-- TemplateType may have one of the following values: BuildAssembly, CreditMemo, Estimate, Invoice, PurchaseOrder, SalesOrder, SalesReceipt, receipt payment, bill payment -->
                                <TemplateType >ENUMTYPE</TemplateType> <!-- required -->
                        </TemplateRet>
                </TemplateQueryRs>
        </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
'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  DoTemplateQuery()
                        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

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

                                WalkTemplateQueryRs(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 BuildTemplateQueryRq(requestMsgSet as IMsgSetRequest)
                        Dim TemplateQueryRq as ITemplateQuery
                        TemplateQueryRq= requestMsgSet.AppendTemplateQueryRq()
                        'Set field value for IncludeRetElementList
                        'May create more than one of these if needed
                        TemplateQueryRq.IncludeRetElementList.Add("ab")
                End Sub




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




                Public Sub WalkTemplateRet(TemplateRet as ITemplateRetList)
                        if (TemplateRet is nothing) then
                                Exit Sub
                        End If

                        'Go through all the elements of ITemplateRetList
                        'Get value of ListID
                        Dim ListID22200 as String
                        ListID22200 = TemplateRet.ListID.GetValue()
                        'Get value of TimeCreated
                        Dim TimeCreated22201 as DateTime
                        TimeCreated22201 = TemplateRet.TimeCreated.GetValue()
                        'Get value of TimeModified
                        Dim TimeModified22202 as DateTime
                        TimeModified22202 = TemplateRet.TimeModified.GetValue()
                        'Get value of EditSequence
                        Dim EditSequence22203 as String
                        EditSequence22203 = TemplateRet.EditSequence.GetValue()
                        'Get value of Name
                        Dim Name22204 as String
                        Name22204 = TemplateRet.Name.GetValue()
                        'Get value of IsActive
                        if ( not TemplateRet.IsActive is nothing) then
                                Dim IsActive22205 as Boolean
                                IsActive22205 = TemplateRet.IsActive.GetValue()
                        End If
                        'Get value of TemplateType
                        Dim TemplateType22206 as ENTemplateType
                        TemplateType22206 = TemplateRet.TemplateType.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
//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  DoTemplateQuery()
                {
                        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;

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

                                WalkTemplateQueryRs(responseMsgSet);
                        }
                        catch (Exception e)
                        {
                                MessageBox.Show(e.Message, "Error");
                                if (sessionBegun)
                                {
                                        sessionManager.EndSession();
                                }
                                if (connectionOpen)
                                {
                                        sessionManager.CloseConnection();
                                }
                        }
                }
                void BuildTemplateQueryRq(IMsgSetRequest requestMsgSet)
                {
                        ITemplateQuery TemplateQueryRq= requestMsgSet.AppendTemplateQueryRq();
                        //Set attributes
                        //Set field value for metaData
                        TemplateQueryRq.metaData.SetValue("IQBENmetaDataType");
                        //Set field value for IncludeRetElementList
                        //May create more than one of these if needed
                        TemplateQueryRq.IncludeRetElementList.Add("ab");
                }




                void WalkTemplateQueryRs(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.rtTemplateQueryRs)
                                                {
                                                        //upcast to more specific type here, this is safe because we checked with response.Type check above
                                                        ITemplateRetList TemplateRet = (ITemplateRetList)response.Detail;
                                                        WalkTemplateRet(TemplateRet);
                                                }
                                        }
                                }
                        }
                }




                void WalkTemplateRet(ITemplateRetList TemplateRet)
                {
                        if (TemplateRet == null) return;
                        //Go through all the elements of ITemplateRetList
                        //Get value of ListID
                        string ListID22193 = (string)TemplateRet.ListID.GetValue();
                        //Get value of TimeCreated
                        DateTime TimeCreated22194 = (DateTime)TemplateRet.TimeCreated.GetValue();
                        //Get value of TimeModified
                        DateTime TimeModified22195 = (DateTime)TemplateRet.TimeModified.GetValue();
                        //Get value of EditSequence
                        string EditSequence22196 = (string)TemplateRet.EditSequence.GetValue();
                        //Get value of Name
                        string Name22197 = (string)TemplateRet.Name.GetValue();
                        //Get value of IsActive
                        if (TemplateRet.IsActive != null)
                        {
                                bool IsActive22198 = (bool)TemplateRet.IsActive.GetValue();
                        }
                        //Get value of TemplateType
                        ENTemplateType TemplateType22199 = (ENTemplateType)TemplateRet.TemplateType.GetValue();
                }




        }
}