Install the .NET SDK

The instructions on this page describe how to install the QuickBooks Online .NET SDK 3.0. This package installs C# libraries such as Intuit.IPP.DataService into a Visual Studio project.

Prerequisites

Registration Requirements:

To use the .NET SDK, you must be registered as an Intuit developer.

Software Requirements:

Before installing the .NET SDK, make sure your development host has the following software installed:

  • Windows 7
  • IIS 7.0 - enabled with ASP.NET, and optionally CGI
  • Microsoft Visual Studio 2015 SP3 or greater - Professional, Express, or Ultimate edition
  • .NET Framework 4.6.1
Note

QuickBooks Online apps must use TLS 1.1 or higher to align with industry best practices for security and data integrity. Beginning March 31, 2018, the required version will be TLS 1.2 or higher.

Dependencies

The .NET SDK has the following dependencies. These are installed as part of the NuGet package.

Installing with NuGet

Prerequisite: On your Windows 7 development host, install NuGet. The NuGet site has detailed installation instructions. If a version of NuGet older than 2.0 is installed on your host, you must manually uninstall it before installing the latest version. For the most current information, see IPP .NET SDK for QuickBooks V3 on the NuGet site.

To install the .NET SDK with NuGet:

  1. Launch Visual Studio.
  2. Create a new project or open an existing project.
  3. From the Tools menu, select Library Package Manager > Manage NuGet Packages for Solution.
  4. On the Manage NuGet Packages window, in the left panel, select Online.
  5. Type IppDotNetSdkForQuickBooksApiV3 in the search box. The search results are displayed in the middle panel.

ManageNuGetPackage.PNG

 

  1. Select Intuit Partner Platform .NET SDK and click Install.
  2. In the Select Projects dialog, select the required projects and click OK.

visual-studio-ippfmsdotnet-install-select-project.PNG

  1. Go to Verifying the Installation below.

Note: The .NET SDK is installed only in the project selected in step 7.

Verify the installation

To verify the installation of the .NET SDK, go to the Solution Explorer and note the Intuit.Ipp entries under References—for example, Intuit.Ipp.DataService.

VerifyTheInstallation.PNG

Updating with NuGet

NuGet Package Manager allows you to install updates directly into your Visual Studio project.

  1. In Visual Studio, open Solution Explorer.
  2. Open the solution on which you have installed the .NET SDK package.
  3. From the Tools menu, select Library Package Manager > Manage NuGet Packages for Solution.
  4. On the Manage NuGet Packages window, in the left panel, select Updates. Available updates are displayed in the middle panel.
  1. On the Intuit Partner Platform .NET SDK download click Update.
  2. In the Select Projects dialog, select the projects to install and click OK.

visual-studio-ippfmsdotnet-install-select-project.PNG

Note: The .NET SDK is updated only in the project selected in step 6.

Check the version of installation

Installed with NuGet

  1. Launch Visual Studio.
  2. Open the project in which the SDK was installed.
  3. From the Tools menu, select Library Package Manager > Manage NuGet Packages for Solution.
  4. On the Manage NuGet Packages window, in the left panel, select Installed packages. The installed packages are displayed in the middle pane.
  5. Select IPP .NET SDK for QuickBooks v3.0.  The version is displayed in the right pane along with other installation details.

CheckingTheVersionWithNuGet.PNG


Did you find this page helpful?
Your feedback helps us make our docs better. Please let us know if this page helped you, or if it needs improvement.

 Got Questions? Get Answers in our developer forums.