Welcome to the Intuit Developer's Time Tracking and Invoicing .NET Sample App.
This sample app is meant to provide working examples of how to integrate your app with the Intuit Small Business ecosystem. Specifically, this sample application demonstrates the following:
- Implementing OAuth to connect an application to a customer's QuickBooks Online company.
- Syncing employee, customer, and service item data from the app's local database to the QuickBooks Online company.
- Using the QuickBooks Online SDK to create TimeActivity and Invoice objects in the QuickBooks Online company.
Please note that while these examples work, features not called out above are not intended to be taken and used in production business applications. In other words, this is not a seed project to be taken cart blanche and deployed to your production environment.
For example, certain concerns are not addressed at all in our samples (e.g. security, privacy, scalability). In our sample apps, we strive to strike a balance between clarity, maintainability, and performance where we can. However, clarity is ultimately the most important quality in a sample app.
Therefore there are certain instances where we might forgo a more complicated implementation (e.g. caching a frequently used value, robust error handling, more generic domain model structure) in favor of code that is easier to read. In that light, we welcome any feedback that makes our samples apps easier to learn from.
- Requirements
- First Use Instructions
- Sync Tables
- Configuration
- Known Issue
- Running the code
- High Level Workflow
- Project Structure
- Class Diagram
- Sequence Diagram
- Activity Diagram
- How To Guides
- More Information
- Feedback
- Release
- Upcoming Release
- Contributing to the Repository
- Reporting Issues
In order to successfully run this sample app you need a few things:
- ![Visual Studio 2013] (images/studio.jpg "Visual Studio Version")
- A developer.intuit.com account
- An app on developer.intuit.com and the associated app token, consumer key, and consumer secret.
- QuickBooks .NET SDK (already included in the project folder)
- Clone the GitHub repo to your computer
- Fill in your Configuration file values ( consumer key, consumer secret) by copying over from the keys section for your app.
- Enable logging in the config file by updating the path.
- Open the project from Visual Studio
- Populate the data in to tables from /Scripts folder
- Refer Figure 2 and connect to database file "tokens.mdf" using server explorer >> connect to database.
- You should be in a position to view tables as displayed in Figure 1
- Execute sql script "InsertScript.sql" under Root\Script folder.
- Refer Figure 4 to make sure you have connected to mdf file before executing the scripts.
- When you are trying to run the solution targetting Internet explorer there is a probability of facing the error seen in Figure 3.
- You can refer the following link http://blogs.msdn.com/b/webdev/archive/2013/06/28/browser-link-feature-in-visual-studio-preview-2013.aspx for solution.
Once the sample app code is on your computer, you can do the following steps to run the app:
- Ctrl + Shift + B to build the solution
- F5 to Run the solution
- Connect to a QuickBooks Online company.
- Setup—sync the following from the local database to the QuickBooks Online company.
- employees—so time can be recorded against a specific service,
- customers—so time can be recorded as billable to a specific customer,
- items—the list of billable services.
- Create and push approved time activity objects to QuickBooks Online company for payroll and billing purposes.
- Create and push invoice objects to QuickBooks Online company for billing purposes.
The following How-To guides related to implementation tasks necessary to produce a production-ready Intuit Partner Platform app (e.g. OAuth, OpenId, etc) are available:
More detailed information can be found here Intuit Developer.
Your feed back is appreciated and it will motivate us to improve the app. Please send your valuable feedback to sumod_madhavan@intuit.com. I will try my best to incorporate the valid requests.
V1.0 - Refer Release.
V2.0 - Introduction of Angulars/Knock-out JS with MVC 5
V3.0 - Introduction of Self Host WEB API with Angular/Knock-out JS and MVC 5
If you find any issues or opportunities for improving this respository, fix them! Feel free to contribute to this project by forking this repository and make changes to the content. Once you've made your changes, share them back with the community by sending a pull request. Please see How to send pull requests for more information about contributing to Github projects. Please help in writing test cases to the Test Project.
If you find any issues with this demo that you can't fix, feel free to report them in the issues section of this repository.