Deluge Help

Fetch Records by ID from Quickbooks

Table of Contents

 Overview

The intuit.quickbooks.getRecordById() task is used to get records from any of the supported modules in your QuickBooks account, by specifying the unique ID of the record. For example, you can get a customer record from the Customer module in quiockbooks with the given record ID. To connect Zoho Creator with QuickBooks, create a new connection from the Setup - Connections page.

 Supported Modules

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

 Syntax

<quickbooksResponse> = intuit.quickbooks.getRecordById(<quickbooksConnectionName>, <quickbooksModuleName>,<quickbooksCompanyId> , <recordId>);

where,
<quickbooksResponse> is the map variable returned by Quickbooks as response. It contains the details of the fetched record.
<quickbooksConnectionName> referes 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 from where the record is fetched.
<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.
<recordId> is the ID in Quickbooks based on which the record related to the ID is fetched.
Refer the Quickboks API Guide for the attributes to be specified for each module.

 Example

A sample script to get a record from the Quickbooks customer module with a given record ID, is given below. You can execute this script from a Zoho Creator form by adding it to the required workflow section.

//returns the record with the specified id
getIdResponse = intuit.quickbooks.getRecordById("Zoho", "Customer", "1241802285", id);
info getIdResponse;

 Response Format

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

{
“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
}","time":"2014-08-07T03:14:33.762-07:00"
}

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"
}]"
}

Share this post : FacebookTwitter

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

Write to us: support@zohocreator.com