(Tcl) QuickBooks - Read an Employee

Demonstrates how to fetch the information for a specific Quickbooks employee. The employee information is fetched by Id. The employee Ids can be obtained by querying the employees and parsing the JSON that is returned.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

#  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.
set jsonToken [new_CkJsonObject]

set success [CkJsonObject_LoadFile $jsonToken "qa_data/tokens/quickbooks.json"]

set oauth1 [new_CkOAuth1]

CkOAuth1_put_ConsumerKey $oauth1 "QUICKBOOKS_CONSUMER_KEY"
CkOAuth1_put_ConsumerSecret $oauth1 "QUICKBOOKS_CONSUMER_SECRET"
CkOAuth1_put_Token $oauth1 [CkJsonObject_stringOf $jsonToken "oauth_token"]
CkOAuth1_put_TokenSecret $oauth1 [CkJsonObject_stringOf $jsonToken "oauth_token_secret"]

set 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.
set bAutoReconnect 1
set success [CkRest_Connect $rest "sandbox-quickbooks.api.intuit.com" 443 1 $bAutoReconnect]
if {[expr $success != 1]} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkOAuth1 $oauth1
    delete_CkRest $rest
    exit
}

CkRest_SetAuthOAuth1 $rest $oauth1 0

#  The company ID is the realmId
set sbPath [new_CkStringBuilder]

CkStringBuilder_Append $sbPath "/v3/company/<companyID>/employee/<employeeID>"
set numReplacements [CkStringBuilder_Replace $sbPath "<companyID>" [CkJsonObject_stringOf $jsonToken "realmId"]]
#  Assume we already know that we want to read the employee whose Id = 60.
set numReplacements [CkStringBuilder_Replace $sbPath "<employeeID>" "60"]

CkRest_AddHeader $rest "Accept" "application/json"
CkRest_put_AllowHeaderFolding $rest 0

set responseBody [CkRest_fullRequestNoBody $rest "GET" [CkStringBuilder_getAsString $sbPath]]
if {[expr [CkRest_get_LastMethodSuccess $rest] != 1]} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkOAuth1 $oauth1
    delete_CkRest $rest
    delete_CkStringBuilder $sbPath
    exit
}

#  We should expect a 200 response if successful.
if {[expr [CkRest_get_ResponseStatusCode $rest] != 200]} then {
    puts "Request Header: "
    puts [CkRest_lastRequestHeader $rest]
    puts "----"
    puts "Response StatusCode = [CkRest_get_ResponseStatusCode $rest]"
    puts "Response StatusLine: [CkRest_responseStatusText $rest]"
    puts "Response Header:"
    puts [CkRest_responseHeader $rest]
    puts "$responseBody"
    delete_CkJsonObject $jsonToken
    delete_CkOAuth1 $oauth1
    delete_CkRest $rest
    delete_CkStringBuilder $sbPath
    exit
}

#  Load the JSON response into a JSON object for parsing.
#  A sample JSON response is shown below.
set json [new_CkJsonObject]

CkJsonObject_Load $json $responseBody

#  These will be used for parsing date/time strings..
set dtime [new_CkDateTime]

set bLocalTime 1
# dt is a CkDtObj

#  Show the JSON.
CkJsonObject_put_EmitCompact $json 0
puts [CkJsonObject_emit $json]

#  Get some information from the JSON..
puts "Name: [CkJsonObject_stringOf $json Employee.DisplayName]"
puts "Id: [CkJsonObject_stringOf $json Employee.Id]"
puts "City: [CkJsonObject_stringOf $json Employee.PrimaryAddr.City]"
puts "PostalCode: [CkJsonObject_stringOf $json Employee.PrimaryAddr.PostalCode]"

#  Load the CreateTime into a CkDateTime...
CkDateTime_SetFromTimestamp $dtime [CkJsonObject_stringOf $json "Employee.MetaData.CreateTime"]
set dt [CkDateTime_GetDtObj $dtime $bLocalTime]
puts [CkDtObj_get_Month $dt]/[CkDtObj_get_Day $dt]/[CkDtObj_get_Year $dt]  [CkDtObj_get_Hour $dt]:[CkDtObj_get_Minute $dt]
delete_CkDtObj $dt

puts "Success."

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

#  {
#    "Employee": {
#      "SSN": "XXX-XX-XXXX",
#      "PrimaryAddr": {
#        "Id": "116",
#        "Line1": "45 N. Elm Street",
#        "City": "Middlefield",
#        "CountrySubDivisionCode": "CA",
#        "PostalCode": "93242"
#      },
#      "BillableTime": false,
#      "domain": "QBO",
#      "sparse": false,
#      "Id": "98",
#      "SyncToken": "0",
#      "MetaData": {
#        "CreateTime": "2015-07-24T09:34:35-07:00",
#        "LastUpdatedTime": "2015-07-24T09:34:35-07:00"
#      },
#      "GivenName": "Bill",
#      "FamilyName": "Miller",
#      "DisplayName": "Bill Miller",
#      "PrintOnCheckName": "Bill Miller",
#      "Active": true,
#      "PrimaryPhone": {
#        "FreeFormNumber": "234-525-1234"
#      }
#    },
#    "time": "2015-07-24T09:35:54.805-07:00"
#  }

delete_CkJsonObject $jsonToken
delete_CkOAuth1 $oauth1
delete_CkRest $rest
delete_CkStringBuilder $sbPath
delete_CkJsonObject $json
delete_CkDateTime $dtime