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.

sampleapp-crud-php's Issues

Send Email subject

I'm looking for a simple way to send an email for an existing invoice.
I see that the SDK supports `$dataService->SendEmail($invoice, "[email protected]");

Is there a way to set a subject and body content?

Any chance to replicate this for Python Flask

I'm having a hard time replicating the examples using Python Flask.

My main objectives are:

1. Create a Sales Receipt
2. Create Invoice
3. Receive payment (applied to specific invoice)

Not very much documentation and samples for developing with Python...

Thanks a lot!

Invoice Crud Create won't work with CA sandbox

The same Invoice Crud Create that works with a US sandbox will not work with a CA sandbox.

What am I doing wrong?
I've even added currencyref as indicated for multicurrency documentation:

            $qbinvoice = Invoice::create([
                "Line" => [
                [
                     "Amount" => 100.00,
                     "DetailType" => "SalesItemLineDetail",
                     "SalesItemLineDetail" => [
                       "ItemRef" => [
                         "value" => 1,
                         "name" => "Services"
                       ]
                     ]
                ]
                ],
                "CustomerRef"=> [
                      "value"=> 1
                ],
                "CurrencyRef"=> [
                      "value"=> "CAD"
                ],
                "BillEmail" => [
                      "Address" => "[email protected]"
                ],
                "BillEmailCc" => [
                      "Address" => "[email protected]"
                ],
                "BillEmailBcc" => [
                      "Address" => "[email protected]"
                ]
            ]);

$urlResource is not defined

SampleApp-CRUD-PHP/CRUD_Examples/JournalEntry/JournalEntryCreate.php

Line 58 in a2e0fed

$xmlBody = XmlObjectSerializer::getPostXmlFromArbitraryEntity($resultingObj, $urlResource);

Use of undefined constant OAUTH_SIG_METHOD_HMACSHA1

I got this issue when I try to fetch contact list.

Use of undefined constant OAUTH_SIG_METHOD_HMACSHA1 - assumed 'OAUTH_SIG_METHOD_HMACSHA1' in E:\xampp\htdocs\demo\quick_book\v3-php-sdk-2.4.1\Security\OAuthRequestValidator.php on line 80

Request is not made successful

Request is not made successful. Response Code:[400] with body: [Invalid NumberInvalid Number : ].
I am trying to update

$item = $dataService->FindbyId('item', 26);
        $theResourceObj = Item::update($item , [
            "QtyOnHand" => 101
        ]);

Any solution!?

PSR-4 and composer

The SDK is now a composer library. Why is this demo not implementing PSR-4 autoloading?

How to create payment type/method ?

How we can manage different types of payment methods?

there are no facades available for IPPPaymentMethod.

shall we add custom facades?

Wrong date upon creating Time Activity

Why startTime and endTime is not reflecting the actual date being passed?

Where to found accessTokenKey, refreshTokenKey, QBORealmID?

I can found ClientID and ClientSecret on my app dashboard. Can anyone tell me where I can find accessTokenKey, refreshTokenKey, QBORealmID? or need to setup along with?

authentication fail

/Customer/CustomerCreate.php - Uncaught QuickBooksOnline\API\Exception\ServiceException: Http Status Code [400]: Request is not made successful. Response Code:[400] with body: [Unsupported OperationOperation Could not find resource for relative : /v3/company/customer of full path: https://c50.sandbox.qbo.intuit.com/qbo50/v3/company/customer?minorversion=8 is not supported.].