Extend Google Sheets with QuickBooks Online Data



Make calls to the API Server from Google Apps Script.

Interact with QuickBooks Online data from Google Sheets through macros, custom functions, and add-ons. The CData API Server, when paired with the ADO.NET Provider for QuickBooks Online (or any of 200+ other ADO.NET Providers), enables connectivity to QuickBooks Online data from cloud-based and mobile applications like Google Sheets. The API Server is a lightweight Web application that produces OData services for QuickBooks Online and any source supported by the CData ADO.NET Providers.

Google Apps Script can consume these OData services in the JSON format. This article shows how to create a simple add-on that populates a Google Spreadsheet with Customers data and, as you make changes, executes updates to QuickBooks Online data.

About QuickBooks Online Data Integration

CData provides the easiest way to access and integrate live data from QuickBooks Online. Customers use CData connectivity to:

  • Realize high-performance data reads thanks to push-down query optimization for complex operations like filters and aggregations.
  • Read, write, update, and delete QuickBooks Online data.
  • Run reports, download attachments, and send or void invoices directly from code using SQL stored procedures.
  • Connect securely using OAuth and modern cryptography, including TLS 1.2, SHA-256, and ECC.

Many users access live QuickBooks Online data from preferred analytics tools like Power BI and Excel, directly from databases with federated access, and use CData solutions to easily integrate QuickBooks Online data with automated workflows for business-to-business communications.

For more information on how customers are solving problems with CData's QuickBooks Online solutions, refer to our blog: https://www.cdata.com/blog/360-view-of-your-customers.


Getting Started


Set Up the API Server

Follow the steps below to begin producing secure QuickBooks Online OData services:

Deploy

The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.

The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.

Connect to QuickBooks Online

After you deploy the API Server and the ADO.NET Provider for QuickBooks Online, provide authentication values and other connection properties needed to connect to QuickBooks Online by clicking Settings -> Connections and adding a new connection in the API Server administration console.

QuickBooks Online uses the OAuth authentication standard. OAuth requires the authenticating user to log in through the browser. To authenticate using OAuth, you can use the embedded OAuthClientId, OAuthClientSecret, and CallbackURL or you can obtain your own by registering an app with Intuit. Additionally, if you want to connect to sandbox data, set UseSandbox to true.

See the Getting Started chapter of the help documentation for a guide to using OAuth.

You can then choose the QuickBooks Online entities you want to allow the API Server to access by clicking Settings -> Resources.

Authorize API Server Users

After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. Access can also be restricted based on IP address: Connections from all addresses except localhost are blocked by default, so you will need to allow connections from Google's servers for this article. You can authenticate as well as encrypt connections with SSL.

Retrieve QuickBooks Online Data

Open the Script Editor from your spreadsheet by clicking Tools -> Script Editor. In the Script Editor, add the following function to populate a spreadsheet with the results of an OData query:

function retrieve(){ var url = "https://MyUrl/api.rsc/Customers?select=Id,DisplayName,Balance,FullyQualifiedName"; var response = UrlFetchApp.fetch(url,{ headers: {"Authorization": "Basic " + Utilities.base64Encode("MyUser:MyAuthtoken")} }); var json = response.getContentText(); var sheet = SpreadsheetApp.getActiveSheet(); var a1 = sheet.getRange('a1'); var index=1; var customers = JSON.parse(json).value; var cols = [["Id","DisplayName","Balance","FullyQualifiedName"]]; sheet.getRange(1,1,1,4).setValues(cols); row=2; for(var i in customers){ for (var j in customers[i]) { switch (j) { case "Id": a1.offset(row,0).setValue(account[i][j]); break; case "DisplayName": a1.offset(row,1).setValue(account[i][j]); break; case "Balance": a1.offset(row,2).setValue(account[i][j]); break; case "FullyQualifiedName": a1.offset(row,3).setValue(account[i][j]); break; } } row++; } }

Follow the steps below to add an installable trigger to populate the spreadsheet when opened:

  1. Click Resources -> Current Project's Triggers -> Add a New Trigger.
  2. Select retrieve in the Run menu.
  3. Select From Spreadsheet.
  4. Select On open.

After closing the dialog, you are prompted to allow access to the application.

Post Changes to QuickBooks Online Data

Add the following function to post changes to cells back to the API Server:

function buildReq(e){ var sheet = SpreadsheetApp.getActiveSheet(); var changes = e.range; var id = sheet.getRange(changes.getRow(),1).getValue(); var col = sheet.getRange(1,changes.getColumn()).getValue(); var url = "http://MyServer/api.rsc/Customers("+id+")"; var putdata = "{\"@odata.type\" : \"CDataAPI.Customers\", \""+col+"\": \""+changes.getValue()+"\"}";; UrlFetchApp.fetch(url,{ method: "put", contentType: "application/json", payload: putdata, headers: {"Authorization": "Basic " + Utilities.base64Encode("MyUser:MyAuthtoken")} }); }

Follow the steps below to add the update trigger:

  1. Click Resources -> Current Project's Triggers.
  2. Select buildReq in the Run menu.
  3. Select From Spreadsheet.
  4. Select On edit.

You can test the script by clicking Publish -> Test as Add-On. Select the version, installation type, and spreadsheet to create a test configuration. You can then select and run the test configuration.

As you make changes to cells, the API Server executes updates to QuickBooks Online data.

Ready to get started?

Learn more or sign up for a free trial:

CData API Server