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

Support:
Documentation:
License:
Binaries:

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 OAuth

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.

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

• To get Prod app keys to get OAuth tokens for live companies: 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.

• Click Test Connect to Oauth->Intuit Anywhere tab->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 then set of 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

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.

Thank you for your contribution!