.Net SDK for QuickBooks REST API v3 services
Clone or download
Latest commit 0473967 Nov 23, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
AddIn/IntuitAnywhereAddin First Commit Jan 23, 2017
IPPDotNetDevKitCSV3 new poco Nov 24, 2018
Installer First Commit Jan 23, 2017
NuGet version 5.2 May 31, 2018
Template First Commit Jan 23, 2017
views add PRS widget Apr 17, 2018
.gitignore updating libraries, adding comments Oct 1, 2018
.gitmodules .Net compiler dll updates Sep 8, 2018
License.md First Commit Jan 23, 2017
README.md Updated framework Nov 22, 2018
os-project-logo.svg adding logo to be used by the OS Site Nov 20, 2018

README.md

SDK Banner

V3-DotNet-SDK

Logo

IDG .NET SDK for QuickBooks V3 (Class lib Project written in .NET Framework 4.6.1)

Support: Help
Documentation: User Guide Refer SDK class lib docs
License: Apache 2
Binaries: Nuget

The QuickBooks Online .NET SDK provides a set of .NET class libraries that make it easier to call QuickBooks Online APIs, and access to QuickBooks Online data. Some of the features included in this SDK are:

  • Ability to perform single and batch processing of CRUD operations on all QuickBooks Online entities.
  • A common interface to the Request and Response Handler with two implemented classes to handle both synchronous and asynchronous requests.
  • Support for both XML and JSON Request and Response formats.
  • Ability to configure app settings in the configuration file requiring no additional code change.
  • Support for Gzip and Deflate compression formats to improve performance of Service calls to QuickBooks Online.
  • Retry policy constructors to help apps handle transient errors.
  • Logging mechanisms for trace and request/response logging.
  • Query Filters that enable you to write Intuit queries to retrieve QuickBooks Online entities whose properties meet a specified criteria.
  • Queries for accessing QuickBooks Reports.
  • Sparse Update to update writable properties specified in a request and leave the others unchanged.
  • Change data that enables you to retrieve a list of entities modified during specified time points.
  • .NET Core is not supported by this SDK.
  • Support for both OAuth1 and OAuth2

Running Tests

Refer to the following steps to generate all the keys required to run tests using OAuth Playground-

  • Go to Developer Docs.

  • Create an app on our IDG platform for the QuickBooks Online v3 APIs.

  • For OAuth2 apps, you will get a set of Development keys, including client key and client secret. This can be used to get OAuth access token and refresh token for sandbox companies.

  • OR for OAuth1 apps, you will get a set of Development keys, including consumer key, consumer secret, and app token. This can be used to get OAuth access tokens for sandbox companies.

  • To get Prod app keys to get OAuth tokens for live companies: Go to your app->Settings tab-> enter all URLs and save. Then get the prod keys from Keys tab under Prod section.

  • To get OAuth access tokens, go to your app's dashboard, Click Oauth Playground

    • For OAuth2 apps, select the desired app and make sure the OAuth playground redirect_uri is present under Keys tab and go through the OAuth authorization flow to get access and refresh tokens along with the realmid to make API calls for QuickBooks company.
      • Access tokens are valid for 1 hour which can be refreshed using refesh token. When you request a fresh access token, always use the refresh token returned in the most recent refreshing access token API response. A refresh token expires 24 hours after you receive it. More info can be found at: Refreshing the access token
    • For OAuth1 apps, set time duration in seconds for 15552000sec and get the access token and secret for your app and company by right-clicking on the page and doing a view source. You will see access token and access token secret and realmid/companyid to make API calls for their QuickBooks company which is valid for 180 days.
      • To 'renew tokens', you can call Reconnect api after 150 days or do Connect to Quickbooks after 180 days to get new tokens.
  • NOTE: For sandbox testing, you need to use dev app keys and sandbox base URL. For live/prod QuickBooks company testing, use prod app keys and prod base URL after doing a private publish as mentioned below. Go to your app->Prod tab-> enter all URLs and save. Then get the prod keys from Keys tab under Prod tab of the app. Please refer-

  • Blog 1

  • Blog 2

  • Unit Tests

    • Add all app keys in the App.config and run tests
  • Integration Tests

    • Add All app keys in the App.config and run tests

Contribute:

We greatly encourage contributions! You can add new features, report and fix existing bugs, write docs and tutorials, or any of the above. Feel free to open issues and/or send pull requests.

The master branch of this repository contains the latest stable release of the SDK, while snapshots are published to the develop branch. In general, pull requests should be submitted against develop by forking this repo into your account, developing and testing your changes, and creating pull requests to request merges. See the Contributing to a Project article for more details about how to contribute.

Steps to contribute:

  1. Fork this repository into your account on Github
  2. Clone your forked repository (not our original one) to your hard drive with git clone https://github.com/YOURUSERNAME/QuickBooks-V3-DotNET-SDK.git
  3. Design and develop your changes
  4. Add/update unit tests
  5. Create a pull request for review to request merge
  6. Obtain approval before your changes can be merged

Note: Before you submit the pull request, make sure to remove the keys and tokens from App.config and App.config that you might have added for testing.

Steps to build the project for devs- For others information... There is a trick to compiling their source code. They projects have many circular references. They side-stepped that issue by having post-build steps in the projects that copy the output to a 'SDK Assemblies' folder that is a peer of the solution 'Code' folder. Then their circular references actually point to those assemblies instead of the peer projects in the solution.

However, their git source does not contain the 'SDK Assemblies' folder. This means their solution will not compile unless you create that folder and populate it with pre-compiled assemblies. So, create that folder and drop their pre-compiled libraries in there. Their git source comes with something like a 'IppDotNetSdkForQuickBooksApiV3.5.3.0.0.nupkg' file. Give that file a .zip extension and you can grab a copy of the libraries from there.

Or try this- In your code, remove all local SDK related lib from each class lib project and instead use nuget to add all those references using IPP .Net SDK package. Then do a clean build and the SDK Assemblies folder will then have correct local assemblies. Then remove Nuget Package/uninstall from all class lib projects and then reference the local assemblies from SDK assemblies folder in each class lib project. This will help you build the project again using local assembly references.

Thank you for your contribution!