IntuitDeveloper / SampleApp-CRUD-PHP

PHP sample app to show how to define basic CRUD operations for entities available in the QuickBooks API using OAuth 2.0 with Composer

SampleApp-CRUD-PHP

Please use this CRUD examples combined with the doc: https://intuit.github.io/QuickBooks-V3-PHP-SDK/

You will find examples with using OAuth1/OAuth2 tokens, SendEmail, get Reports, DownloadPDF, etc in the doc.

SampleApp-CRUD-PHP

Welcome to the Intuit Developer's PHP Sample App for CRUD operations.

This sample app provides working examples of how to integrate your app with the Intuit Small Business ecosystem. Specifically, this sample app demonstrates how to:

• Use the Create, Read, Query, Update, Delete, and Void entities
• Perform operations using the QuickBooks PHP SDK

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.

Table of Contents

• Requirements
• First Use Instructions
• Running the code
• Project Structure

Requirements

In order to successfully run this sample app you need a few things:

1. Install the PHP SDK. Refer to the instructions here.
2. A developer.intuit.com account.
3. An app on developer.intuit.com and the associated app token, consumer key, and consumer secret.
4. One sandbox company, connect the company with your app and generate the OAuth tokens.

First Use Instructions

1. Clone the GitHub repo to your computer.
2. Update your OAuth 2 tokens

Running the code

This app provides individual sample code for CRUD operations for various QBO entities. Each PHP file can be run individually.

Steps described below is to run the PHP file for creating a customer.

1. Open the terminal window or command prompt and cd into the CRUD directory /SampleApp-CRUD-PHP/CRUD/Customer.
2. Run the command php CustomerCreate.php.
3. On the console you'll see the log being generated with the new customer ID.
4. Request/Response XMLs are generated in the folder you specified.

Follow similar steps for other classes.

Note: The sample code has been implemented for a company with a US locale. Certain fields may not be applicable for other locales or minor versions. Care should be taken to handle such scenarios separately.