PHP Extension Requires Chilkat v11.0.0+

QuickBooks - Query Employees

See more QuickBooks Examples

Demonstrates how to query the QuickBooks employee data. 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 == false) {
    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 Employee';
$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() == false) {
    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->Load($responseBody);

//  Show the full JSON response.
$json->put_EmitCompact(false);
print $json->emit() . "\n";

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

//  These will be used for parsing date/time strings..
$dtime = new CkDateTime();
$bLocalTime = true;
$dt = new CkDtObj();

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

    $json->put_I($i);
    print 'DisplayName: ' . $json->stringOf('QueryResponse.Employee[i].DisplayName') . "\n";
    print 'Id: ' . $json->stringOf('QueryResponse.Employee[i].Id') . "\n";
    print 'Active: ' . $json->BoolOf('QueryResponse.Employee[i].Active') . "\n";

    //  Load the CreateTime into a CkDateTime...
    $dtime->SetFromTimestamp($json->stringOf('QueryResponse.Employee[i].MetaData.CreateTime'));
    $dtime->ToDtObj($bLocalTime,$dt);

    print $dt->get_Month() . '/' . $dt->get_Day() . '/' . $dt->get_Year() . '  ' . $dt->get_Hour() . ':' . $dt->get_Minute() . "\n";

    //  The the birth year, month, and day, if it exists.
    //  The BirthDate contains something like this: "1985-09-11"
    if ($json->HasMember('QueryResponse.Employee[i].BirthDate') == true) {
        $sTab = new CkStringTable();
        $sTab->SplitAndAppend($json->stringOf('QueryResponse.Employee[i].BirthDate'),'-',true,true);
        $year = $sTab->stringAt(0);
        $month = $sTab->stringAt(1);
        $day = $sTab->stringAt(2);
        print 'BirthDate: ' . $month . '/' . $day . '/' . $year . "\n";
    }

    print '----' . "\n";
    $i = $i + 1;
}

print 'Success.' . "\n";

//  ------------------------------------------------------
//  The JSON response looks like this:

//  {
//    "QueryResponse": {
//      "Employee": [
//        {
//          "BillableTime": false,
//          "domain": "QBO",
//          "sparse": false,
//          "Id": "55",
//          "SyncToken": "0",
//          "MetaData": {
//            "CreateTime": "2016-09-15T11:21:48-07:00",
//            "LastUpdatedTime": "2016-09-15T11:21:48-07:00"
//          },
//          "GivenName": "Emily",
//          "FamilyName": "Platt",
//          "DisplayName": "Emily Platt",
//          "PrintOnCheckName": "Emily Platt",
//          "Active": true
//        },
//        {
//          "BillableTime": false,
//          "BirthDate": "1985-09-11",
//          "HiredDate": "2016-08-17",
//          "domain": "QBO",
//          "sparse": false,
//          "Id": "54",
//          "SyncToken": "1",
//          "MetaData": {
//            "CreateTime": "2016-09-15T11:21:28-07:00",
//            "LastUpdatedTime": "2016-09-15T11:46:26-07:00"
//          },
//          "GivenName": "John",
//          "FamilyName": "Johnson",
//          "DisplayName": "John Johnson",
//          "PrintOnCheckName": "John Johnson",
//          "Active": true,
//          "PrimaryPhone": {
//            "FreeFormNumber": "(540) 555-9645"
//          }
//        },
//        {
//          "SSN": "XXX-XX-XXXX",
//          "PrimaryAddr": {
//            "Id": "98",
//            "Line1": "45 N. Elm Street",
//            "City": "Middlefield",
//            "CountrySubDivisionCode": "CA",
//            "PostalCode": "93242"
//          },
//          "BillableTime": false,
//          "domain": "QBO",
//          "sparse": false,
//          "Id": "60",
//          "SyncToken": "0",
//          "MetaData": {
//            "CreateTime": "2016-10-25T14:08:18-07:00",
//            "LastUpdatedTime": "2016-10-25T14:08:18-07:00"
//          },
//          "GivenName": "John",
//          "FamilyName": "Meuller",
//          "DisplayName": "John Meuller",
//          "PrintOnCheckName": "John Meuller",
//          "Active": true,
//          "PrimaryPhone": {
//            "FreeFormNumber": "408-525-1234"
//          }
//        }
//      ],
//      "startPosition": 1,
//      "maxResults": 3
//    },
//    "time": "2016-10-25T14:18:38.487-07:00"
//  }

?>