PHP Extension

QuickBooks - Query a Customer

See more QuickBooks Examples

Demonstrates how to query QuickBooks customers.

A sample JSON response body is available at Sample Quickbooks Customer Query JSON Response

PHP Extension

<?php

include("chilkat.php");

$success = false;

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// Get our previously obtained OAuth2 access token, which should contain JSON like this:
// {
//   "expires_in": 3600,
//   "x_refresh_token_expires_in": 8726400,
//   "refresh_token": "L011546037639r ... 3vR2DrbOmg0Sdagw",
//   "access_token": "eyJlbmMiOiJBMTI4Q0 ... oETJEMbeggg",
//   "token_type": "bearer"
// }

$jsonToken = new CkJsonObject();
$success = $jsonToken->LoadFile('qa_data/tokens/qb-access-token.json');

$rest = new CkRest();

// Connect using TLS.
// A single REST object, once connected, can be used for many Quickbooks REST API calls.
// The auto-reconnect indicates that if the already-established HTTPS connection is closed,
// then it will be automatically re-established as needed.
$bAutoReconnect = true;
$success = $rest->Connect('sandbox-quickbooks.api.intuit.com',443,true,$bAutoReconnect);
if ($success != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

$sbAuth = new CkStringBuilder();
$sbAuth->Append('Bearer ');
$sbAuth->Append($jsonToken->stringOf('access_token'));
$rest->put_Authorization($sbAuth->getAsString());

$rest->AddHeader('Accept','application/json');
$rest->put_AllowHeaderFolding(false);

$query = 'select * from Customer';
$rest->AddQueryParam('query',$query);
$rest->AddQueryParam('minorversion','45');

// The company ID is 123146096291789
$responseBody = $rest->fullRequestNoBody('GET','/v3/company/123146096291789/query');
if ($rest->get_LastMethodSuccess() != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

// We should expect a 200 response if successful.
if ($rest->get_ResponseStatusCode() != 200) {
    print 'Request Header: ' . "\n";
    print $rest->lastRequestHeader() . "\n";
    print '----' . "\n";
    print 'Response StatusCode = ' . $rest->get_ResponseStatusCode() . "\n";
    print 'Response StatusLine: ' . $rest->responseStatusText() . "\n";
    print 'Response Header:' . "\n";
    print $rest->responseHeader() . "\n";
    print $responseBody . "\n";
    exit;
}

// Load the JSON response into a JSON object for parsing.
// A sample JSON response is shown below.
$json = new CkJsonObject();
$json->put_EmitCompact(false);
$json->Load($responseBody);

// Use this online tool to generate parsing code from sample JSON: 
// Generate Parsing Code from JSON

// Iterate over each customer returned.
$numRecords = $json->SizeOfArray('QueryResponse.Customer');
$i = 0;
while ($i < $numRecords) {

    $json->put_I($i);
    print 'Name: ' . $json->stringOf('QueryResponse.Customer[i].FullyQualifiedName') . "\n";
    print 'Id: ' . $json->stringOf('QueryResponse.Customer[i].Id') . "\n";
    print 'City: ' . $json->stringOf('QueryResponse.Customer[i].BillAddr.City') . "\n";
    print '----' . "\n";
    $i = $i + 1;
}

print 'Success.' . "\n";

?>