QuickBooks qbXML Element: IncludeRetElement

The

<IncludeRetElement>...</IncludeRetElement>

tag in qbXML can be used in qbXML queries to tell QuickBooks what data to return in the response.

By default, all data for the given object is returned. For example, if you issue a CustomerQuery, you'll get back the entire customer record(s).

You have to be especially careful when specifying IncludeRetElement tags that:

• The element is available in the normal qbXML response
• The cAsE (uppercase, lowercase) is correct
• You're not specifying an element within an aggregate (i.e. you can't just get the <City> element within a <ShipAddress> aggregate, you have to get the entire <ShipAddress> and parse <City> out yourself)

If you only wanted the names of your customers, you could issue a CustomerQuery that looked like this:

<?xml version="1.0" encoding="utf-8"?>
<?qbxml version="4.0"?>
<QBXML>
	<QBXMLMsgsRq onError="stopOnError">
		<CustomerQueryRq requestID="xyz"> 
			<IncludeRetElement>Name</IncludeRetElement>
		</CustomerQueryRq>
	</QBXMLMsgsRq>
</QBXML>