Perl

QuickBooks - Read an Employee (with Error Response)

See more QuickBooks Examples

Demonstrates how to fetch the information for a specific Quickbooks employee, but tries to fetch using an invalid employee id. Shows the error response and how to parse it. Perl

use chilkat();

$success = 0;

# 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 = chilkat::CkJsonObject->new();
$success = $jsonToken->LoadFile("qa_data/tokens/qb-access-token.json");

$rest = chilkat::CkRest->new();

# 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 = 1;
$success = $rest->Connect("sandbox-quickbooks.api.intuit.com",443,1,$bAutoReconnect);
if ($success != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

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

$rest->AddHeader("Accept","application/json");
$rest->put_AllowHeaderFolding(0);

# The company ID is 123146096291789
# The employee ID is 999  (There is no employee with this ID and we should get a 400 response code w/ a response body indicating the error.)
$responseBody = $rest->fullRequestNoBody("GET","/v3/company/123146096291789/employee/999?minorversion=45");
if ($rest->get_LastMethodSuccess() != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

# Load the JSON response into a JSON object for parsing.
# A sample JSON response is shown below.
$json = chilkat::CkJsonObject->new();
$json->Load($responseBody);
$json->put_EmitCompact(0);
print $json->emit() . "\r\n";

# A 400 response is what we'd expect if trying to query for a non-existent employee ID
if ($rest->get_ResponseStatusCode() != 400) {
    print "Request Header: " . "\r\n";
    print $rest->lastRequestHeader() . "\r\n";
    print "----" . "\r\n";
    print "Response StatusCode = " . $rest->get_ResponseStatusCode() . "\r\n";
    print "Response StatusLine: " . $rest->responseStatusText() . "\r\n";
    print "Response Header:" . "\r\n";
    print $rest->responseHeader() . "\r\n";
    exit;
}

# If we got here, the response status code was 400..
# Iterate over the errors..
$numErrors = $json->SizeOfArray("Fault.Error");
$i = 0;
while ($i < $numErrors) {

    $json->put_I($i);
    print "Message: " . $json->stringOf("Fault.Error[i].Message") . "\r\n";
    print "Detail: " . $json->stringOf("Fault.Error[i].Detail") . "\r\n";
    print "code: " . $json->stringOf("Fault.Error[i].code") . "\r\n";
    print "----" . "\r\n";
    $i = $i + 1;
}

# ------------------------------------------------------
# The JSON error response looks like this:

# {
#   "Fault": {
#     "Error": [
#       {
#         "Message": "Object Not Found",
#         "Detail": "Object Not Found : Something you're trying to use has been made inactive. Check the fields with accounts, customers, items, vendors or employees.",
#         "code": "610",
#         "element": ""
#       }
#     ],
#     "type": "ValidationFault"
#   },
#   "time": "2020-03-07T10:21:19.089-08:00"
# }