Build MVC Applications with Connectivity to QuickBooks Data



This article shows how to use only the Entity Framework and the CData ADO.NET provider to access QuickBooks from an ASP.NET MVC application.

In this article, we will guide you through the process of utilizing wizards within Visual Studio to seamlessly integrate the CData ADO.NET Provider for QuickBooks into a basic MVC (Model, View, Controller) project.

About QuickBooks Data Integration

CData simplifies access and integration of live QuickBooks data. Our customers leverage CData connectivity to:

  • Access both local and remote company files.
  • Connect across editions and regions: QuickBooks Premier, Professional, Enterprise, and Simple Start edition 2002+, as well as Canada, New Zealand, Australia, and UK editions from 2003+.
  • Use SQL stored procedures to perform actions like voiding or clearing transactions, merging lists, searching entities, and more.

Customers regularly integrate their QuickBooks data with preferred tools, like Power BI, Tableau, or Excel, and integrate QuickBooks data into their database or data warehouse.


Getting Started


Create the Entity Framework Model

Follow the steps below to save connection properties and map tables to entities in the data model.

  1. Create a new MVC project in Visual Studio. In this example, the project name is MvcQuickBooksApp.
  2. If you are using Entity Framework 6, you will need to take the preliminary step of registering the QuickBooks Entity Framework provider for your project. See the "LINQ and Entity Framework" chapter in the help documentation for a guide.

    Note that MVC 3 scaffolding and MVC 4 scaffolding do not support Entity Framework 6. You can use your scaffolding with Entity Framework 6 by upgrading to the latest version of MVC.

  3. To add the .edmx file from the designer, right-click your Models folder and click Add New Item. Select ADO.NET Entity Data Model, name the model, and click Add. In this example, the name of the model is QuickBooksModel.
  4. In the Entity Data Model wizard, select the option 'EF Designer from database'. The Entity Data Model wizard is displayed.
  5. Click New Connection. Select CData QuickBooks Data Source in the dialog that is displayed.
  6. Specify the required connection string properties.

    When you are connecting to a local QuickBooks instance, you do not need to set any connection properties.

    Requests are made to QuickBooks through the Remote Connector. The Remote Connector runs on the same machine as QuickBooks and accepts connections through a lightweight, embedded Web server. The server supports SSL/TLS, enabling users to connect securely from remote machines.

    The first time you connect, you will need to authorize the Remote Connector with QuickBooks. See the "Getting Started" chapter of the help documentation for a guide.

    A typical connection string is below:

    URL=http://remotehost:8166;User=admin;Password=admin123;
  7. Name the connection and select whether to include sensitive information, such as connection credentials, in the connection string. For simplicity, this example saves sensitive information in Web.config. The connection settings are saved as QuickBooksEntities.

  8. Select the tables and views you need. In this example, Customers is imported. Also, the option to pluralize object names is deselected in this example. Click Finish to create the .edmx file.
  9. Build your project to complete this step.

Scaffold the Controller and Views

Once you've established the model and completed the project build, you can employ ASP.NET Scaffolding wizards to generate both the controller and the views.

  1. In Solution Explorer, right-click the controllers folder and click Add -> Controller. Select MVC 5 Controller with views, using Entity Framework.
  2. In the Add Controller dialog that is then displayed, select the following options:

    • Model class: Select a table you imported; for example, Customers.
    • Data context class: Select your context class.
  3. Leave the default values for the other fields.

You can now access the list of Customers records at http://MySite/Customers. Next to each record are links to edit, delete, and see more information. You can also create new Customers records. With every state change the site picks up any data changes.

Ready to get started?

Download a free trial of the QuickBooks Data Provider to get started:

 Download Now

Learn more:

QuickBooks Icon QuickBooks ADO.NET Provider

Complete read-write access to QuickBooks enables developers to search (Customers, Transactions, Invoices, Sales Receipts, etc.), update items, edit customers, and more, from any .NET application.