Search Records in QuickBooks

Table of Contents

  Overview

The intuit.quickbooks.searchRecords() task is used to search records from any of the supported modules in your QuickBooks account, directly from your Zoho CRM system.  For example, you can search for customers from the Customer module in quiockbooks with a given display name. To connect Zoho CRM with QuickBooks, download and install the QuickBooks connector from the Zoho Marketplace .

  Supported Modules

The following Quickbooks modules are supported by the intuit.quickbooks task

  • Customer
  • Vendor
  • Item
  • Invoice
  • Account
  • Employee
  • Department

  Syntax

<quickbooksResponse> = intuit.quickbooks.searchRecords("zoho_quickbooks",<quickbooks CompanyId> , <Select Query>);

where, 
<quickbooksResponse> is the map variable returned as response. It contains the details of the fetched records. 
<quickbooksCompanyId> refers to the unique ID generated by Quickbooks for each account. Refer CompanyId  for more information.
<Select Query> in the format,
select <requiredColumns> from <moduleName> where <attribute name> = <value> 
Refer the Quickboks API Guide  for the attributes to be specified for each module.

  Example - Search records from quickbooks

A sample script to search records from the Quickbooks customer module with a given display name, is given below.  For example, to search for specific records from the customer module, 

//returns a list of records with DisplayName ="Henry"
searchResponse = intuit.quickbooks.searchRecords("zoho_quickbooks", "1241802285", "SELECT * FROM Customer where DisplayName='Henry'");
 

  Example - Get ID of the records

queryResponse = (searchResponse.get("QueryResponse")).toMap();
queryResponseList = queryResponse.get("Customer").toJSONList();
//iterate each value in list
for each rec in queryResponseList
{
recMap = rec.toMap();
id = recMap.get("Id");
info id ;
}

Note

  • You can add the script directly to the editor area by selecting Free-flow scripting link displayed on the top-right corner of the script builder ( or ) use the drag-and-drop functionality in Script Builder.

  Response Format

The response returned by Quickbooks will be in the format given below.

{
“time":"2014-08-06T04:45:08.234-07:00",
"QueryResponse":"{" Customer":"[{" ShipAddr":{
"Line3":"123 street",
"Long":"-122.0960826",
"Line2":"Building 1",
"Line1":"Intuit",
"Lat":"37.4306346",
"Id":"7"
},
"PreferredDeliveryMethod":"Email",
"BalanceWithJobs":0,
"DisplayName":"Henry",
"FullyQualifiedName":"Henry",
"BillWithParent":false,
"Job":false,
"Active":true,
"MetaData":{
"CreateTime":"2014-08-01T02:29:29-07:00",
"LastUpdatedTime":"2014-08-01T02:35:45-07:00"
},
"Taxable":false,
"BillAddr":{
"Long":"-77.02225539999999",
"Line1":"450 7th StreetnWashington DC",
"Lat":"38.8958239",
"Id":"6"
},
"domain":"QBO",
"SyncToken":"1",
"PrintOnCheckName":"Hudson",
"CurrencyRef":{
"name":"Indian Rupee",
"value":"INR"
},
"Id":"5",
"FamilyName":"Hudson",
"Balance":0,
"sparse":false
}
]","maxResults":1,
"startPosition":1
}
}

If for some reason, the execution fails, the response will be in the following format.

ERROR RESPONSE - For Invalid Parameter Name

{
"Error":"[{
"Detail":"Property Name:Can not instanti specified is unsupported or invalid",
"Message":"Request has invalid or unsupported property",
"code":"2010"
}]"
}