Creator Help

Get Records from Quickbooks

Table of Contents


The intuit.quickbooks.getRecords() task is used to get records from any of the supported modules in your QuickBooks account, directly from your Zoho Creator application.  For example, you can get a list of customers from the Customer module in quiockbooks with a given display name.  To connect Zoho Creator with QuickBooks, create a new connection from the Setup - Connections page. 

 Supported Modules

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


<quickbooksResponse> = intuit.quickbooks.getRecords(<quickbooksConnectionName>, <quickbooksModuleName>,<quickbooks CompanyId> , <criteria>, <columnsToBeSelected>);

<quickbooksResponse> is the map variable returned as response. It contains the details of the newly created record. 
<quickbooksConnectionName> refers to the connection name used to connect Zoho Creator with Quickbooks. Create a new connection from the Setup - Connections page. 
<quickbooksModuleName> refers to the module name in Quick Books where the record is created. 
<quickbooksCompanyId> 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.
<criteria> is the optional parameter based on which the records wll be fetched. The criteria must be in the format <attribute name> = <value>. For example, "DisplayName = 'Henry'"
<columnsToBeSelected> is the optional parameter which specifies the name of the attributes to be selected.
Refer the Quickboks API Guide for the attributes to be specified for each module. 

 Example - Get records from quickbooks

A sample script to get records from the Quickbooks customer module with a given display name, is given below. You can execute this script from a Zoho Creator form by adding it to the required Form Actions block.  For example, to get specific records from the customer module,

//returns all records in customer module
getResponse = intuit.quickbooks.getRecords("Zoho", "Customer", "1241802285");

//returns a list of records with DisplayName ="Henry"
getResponse = intuit.quickbooks.getRecords("Zoho", "Customer", "1241802285", "DisplayName='Henry'");

//returns the FamilyName and ID of the records with DisplayName ="Henry" 

fieldList = List();

getResponse = intuit.quickbooks.getRecords("Zoho", "Customer", "1241802285", "DisplayName = 'Henry'",fieldList);

 Example - Get ID of the records

queryResponse = (getResponse .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 ;


  • 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 for the getRecords task given below.
intuit.quickbooks.getRecords("Zoho", "Customer", "1241802285", "DisplayName='Henry'");

"QueryResponse":"{" Customer":"[{" ShipAddr":{
"Line3":"123 street",
"Line2":"Building 1",
"Line1":"450 7th StreetnWashington DC",
"name":"Indian Rupee",

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

ERROR RESPONSE - For Invalid Parameter Name

"Detail":"Property Name:Can not instanti specified is unsupported or invalid",
"Message":"Request has invalid or unsupported property",

 Using Script Builder

To add the script using the drag-n-drop functionality in Script Builder,

  1. Select the Form from your Dashboard page
  2. Select the required Form Action from Settings - Workflow.
  3. Click on Script Builder from the top-right cormer of the page.
  4. Drag and drop the call function in the editor box. 
  5. Select Integration tasks
  6. Select Service as Quickbooks
  7. Select Function as Get Records.
  8. Select the Connection Name to connect with Quickbooks. Click on +Create to create a new connection or create a new connection from the Setup - Connections page
  9. Select the required Module Name.
  10. Specify the unique Company ID of your Quickbooks account. Refer CompanyId for more information.
  11. Specify the criteria based on which the records will be fetched. This is an optional parameter. 
  12. Specify the columns to be fetched. This is an optional parameter.
  13. Specify the response variable that will hold the response returned by Quickbooks.
  14. Click on Done to insert the call function task.

The response variable will contain the response returned by Quickbooks in list format.

Share this post : FacebookTwitter

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

Write to us: