Querying for a Customer by Name

Querying for a Customer by Name

Example Request

<?xml version="1.0" encoding="utf-8"?>
<?qbxml version="5.0"?>
<QBXML>
	<QBXMLMsgsRq onError="stopOnError">
		<CustomerQueryRq requestID="Q3VzdG9tZXJRdWVyeXwyODk2">
			<FullName>Keith Palmer</FullName>
		</CustomerQueryRq>
	</QBXMLMsgsRq>
</QBXML>

Example Response (if found)

If QuickBooks found a record (or many records) which matched your query, you'll get back something that looks like this:

<?xml version="1.0" ?>
<QBXML>
	<QBXMLMsgsRs>
		<CustomerQueryRs requestID="Q3VzdG9tZXJRdWVyeXwyODk2" statusCode="0" statusSeverity="Info" statusMessage="Status OK">
			<CustomerRet>
				<ListID>10006-1211236622</ListID>
				<TimeCreated>2008-05-19T18:37:02-05:00</TimeCreated>
				<TimeModified>2008-06-10T23:35:56-05:00</TimeModified>
				<EditSequence>1213155356</EditSequence>
				<Name>Keith Palmer</Name>
				<FullName>Keith Palmer</FullName>
				<IsActive>true</IsActive>
				<Sublevel>0</Sublevel>
				<FirstName>Keith</FirstName>
				<LastName>Palmer</LastName>
				<BillAddress>
					<Addr1>134 Stonemill Road</Addr1>
					<Addr2>Suite D</Addr2>
					<City>Storrs</City>
					<State>CT</State>
					<PostalCode>06268</PostalCode>
					<Country>USA</Country>
				</BillAddress>
				<ShipAddress>
					<Addr1>134 Stonemill Road</Addr1>
					<Addr2>Suite D</Addr2>
					<City>Storrs</City>
					<State>CT</State>
					<PostalCode>06268</PostalCode>
					<Country>USA</Country>
				</ShipAddress>
				<Phone>(860) 634-1602</Phone>
				<Fax>(860) 429-5182</Fax>
				<Email>keith@uglyslug.com</Email>
				<Balance>250.00</Balance>
				<TotalBalance>250.00</TotalBalance>
				<SalesTaxCodeRef>
					<ListID>20000-1211065841</ListID>
					<FullName>Non</FullName>
				</SalesTaxCodeRef>
				<ItemSalesTaxRef>
					<ListID>10000-1211066051</ListID>
					<FullName>Out of State</FullName>
				</ItemSalesTaxRef>
				<JobStatus>None</JobStatus>
			</CustomerRet>
			
			... if more than one customer is returned, you'll get additional CustomerRet records here ...
		
		</CustomerQueryRs>
	</QBXMLMsgsRs>
</QBXML>

Example Response (if not found)

If QuickBooks did not find any matching objects in the database (i.e. there is no customer named “Keith Palmer” in QuickBooks) then you'll get back an error message. It will look like this:

<?xml version="1.0" ?>
<QBXML>
	<QBXMLMsgsRs>
		<CustomerQueryRs requestID="Q3VzdG9tZXJRdWVyeXwyODk2" statusCode="500" statusSeverity="Warn" statusMessage="The query request has not been fully completed. There was a required element (&quot;Keith Palmer&quot;) that could not be found in QuickBooks." />
	</QBXMLMsgsRs>
</QBXML>