Search records

Search records in Quickbooks

Overview

Search records in Quickbooks using a criteria.

Note: This task is applicable only to Zoho Creator.

Syntax

<variable> = intuit.quickbooks.searchRecords(<quickbooks_connection>, <company_ID><criteria>);

where,

ParameterDescriptionData type

<variable> 

is the variable which will hold the response returned by Quickbooks.

KEY-VALUE

<quickbooks_connection> 

is the name of the Quickbooks connection.

TEXT
<company_ID>

refers to the unique ID generated by Quickbooks for each account.

You can find this under Your Company -> Account and Settings -> Billing & Subscription -> Company Id in your Quickbooks account.

TEXT

<criteria>

is the criteria based on which records will be searched.

The criteria must be in the following format:
"SELECT <columns_seperated_by_comma> FROM <module> WHERE <field>=<'value'>"

The specified columns' values will be returned from the specified module from the records which meet the criteria.

To retrieve values of all the columns, specify an asterisk *. For example: "SELECT * FROM <module> WHERE <field>=<'value'>" 

Following are the names of applicable modules.

Customer

Vendor

Item

Invoice
AccountEmployee Department
TEXT

Search records by criteria in Quickbooks

The following snippet searches for records which meet the criteria, and returns the values for the specified columns. 

response = intuit.quickbooks.searchRecords("Quickbooks", "1241802285", "SELECT * FROM Customer WHERE DisplayName='Henry'");

where,

ParameterDescription
"Quickbooks"is the name of the Quickbooks Connection
"1241802285"is the company ID of the account in which the records will be searched
*values of all the fields will be included in the response
"Customer​"is the module in Quickbooks, where the records will be searched
DisplayName='Henry'is the criteria based on which the record will be fetched.

Response Format

Following is a sample success response returned by Salesforce:

{  
   “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
}
}

The following is a sample failure response returned due to invalid paramter name:

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

Related Links

Share this post : FacebookTwitter

Still can't find what you're looking for?

Write to us: support@zohodeluge.com