Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

Perl Web API Examples

Primary Categories

AWS Translate
Azure Maps
Azure OAuth2
Azure Storage Accounts
CardConnect
Cloudfare
Facebook
GeoOp
Jira
Magento
Microsoft Calendar
Microsoft Group
Microsoft Tasks and Plans

PayPal
Peoplevox
Populi
QuickBooks
SOAP finkok.com
Shopify
Stripe
SugarCRM
Trello
Twitter
VoiceBase
Walmart
Xero
eBay
effectconnect

 

 

 

(Perl) QuickBooks - Query Employees

Demonstrates how to query the QuickBooks employee data.

Chilkat Perl Downloads

Perl Module for Windows, Linux, Alpine Linux,
MAC OS X, Solaris, FreeBSD, OpenBSD,
Raspberry Pi and other single board computers

use chilkat();

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

# This example also assumes an OAuth1 access token was previously fetched.
# and saved in a JSON file.  See the Chilkat online examples at example-code.com
# for Quickbooks OAuth1 examples (in the Quickbooks and OAuth1 categories)
# 

# First get our previously obtained access token.
$jsonToken = chilkat::CkJsonObject->new();
$success = $jsonToken->LoadFile("qa_data/tokens/quickbooks.json");

$oauth1 = chilkat::CkOAuth1->new();
$oauth1->put_ConsumerKey("QUICKBOOKS_CONSUMER_KEY");
$oauth1->put_ConsumerSecret("QUICKBOOKS_CONSUMER_SECRET");
$oauth1->put_Token($jsonToken->stringOf("oauth_token"));
$oauth1->put_TokenSecret($jsonToken->stringOf("oauth_token_secret"));

$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;
}

$rest->SetAuthOAuth1($oauth1,0);

# The company ID is the realmId
$sbPath = chilkat::CkStringBuilder->new();
$sbPath->Append("/v3/company/<companyID>/query");
$numReplacements = $sbPath->Replace("<companyID>",$jsonToken->stringOf("realmId"));

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

$query = "select * from Employee";
$rest->AddQueryParam("query",$query);
$rest->AddQueryParam("minorversion","4");

$responseBody = $rest->fullRequestNoBody("GET",$sbPath->getAsString());
if ($rest->get_LastMethodSuccess() != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

# We should expect a 200 response if successful.
if ($rest->get_ResponseStatusCode() != 200) {
    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";
    print $responseBody . "\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);

# Show the full JSON response.
$json->put_EmitCompact(0);
print $json->emit() . "\r\n";

# These will be used for parsing date/time strings..
$dtime = chilkat::CkDateTime->new();
$bLocalTime = 1;

# 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") . "\r\n";
    print "Id: " . $json->stringOf("QueryResponse.Employee[i].Id") . "\r\n";
    print "Active: " . $json->BoolOf("QueryResponse.Employee[i].Active") . "\r\n";

    # Load the CreateTime into a CkDateTime...
    $dtime->SetFromTimestamp($json->stringOf("QueryResponse.Employee[i].MetaData.CreateTime"));
    # dt is a DtObj
    $dt = $dtime->GetDtObj($bLocalTime);
    print $dt->get_Month() . "/" . $dt->get_Day() . "/" . $dt->get_Year() . "  " . $dt->get_Hour() . ":"
         . $dt->get_Minute() . "\r\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") == 1) {
        $sTab = chilkat::CkStringTable->new();
        $sTab->SplitAndAppend($json->stringOf("QueryResponse.Employee[i].BirthDate"),"-",1,1);
        $year = $sTab->stringAt(0);
        $month = $sTab->stringAt(1);
        $day = $sTab->stringAt(2);
        print "BirthDate: " . $month . "/" . $day . "/" . $year . "\r\n";
    }

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

print "Success." . "\r\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"
# 

 

© 2000-2019 Chilkat Software, Inc. All Rights Reserved.