Tcl Requires Chilkat v11.0.0+
Tcl
QuickBooks - Query Employees
See more QuickBooks Examples
Demonstrates how to query the QuickBooks employee data.Chilkat Tcl Downloads
load ./chilkat.dll
set 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"
# }
set jsonToken [new_CkJsonObject]
set success [CkJsonObject_LoadFile $jsonToken "qa_data/tokens/qb-access-token.json"]
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 {$success == 0} then {
puts [CkRest_lastErrorText $rest]
delete_CkJsonObject $jsonToken
delete_CkRest $rest
exit
}
set sbAuth [new_CkStringBuilder]
CkStringBuilder_Append $sbAuth "Bearer "
CkStringBuilder_Append $sbAuth [CkJsonObject_stringOf $jsonToken "access_token"]
CkRest_put_Authorization $rest [CkStringBuilder_getAsString $sbAuth]
CkRest_AddHeader $rest "Accept" "application/json"
CkRest_put_AllowHeaderFolding $rest 0
set query "select * from Employee"
CkRest_AddQueryParam $rest "query" $query
CkRest_AddQueryParam $rest "minorversion" "45"
# The company ID is 123146096291789
set responseBody [CkRest_fullRequestNoBody $rest "GET" "/v3/company/123146096291789/query"]
if {[CkRest_get_LastMethodSuccess $rest] == 0} then {
puts [CkRest_lastErrorText $rest]
delete_CkJsonObject $jsonToken
delete_CkRest $rest
delete_CkStringBuilder $sbAuth
exit
}
# We should expect a 200 response if successful.
if {[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_CkRest $rest
delete_CkStringBuilder $sbAuth
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
# Show the full JSON response.
CkJsonObject_put_EmitCompact $json 0
puts [CkJsonObject_emit $json]
# 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..
set dtime [new_CkDateTime]
set bLocalTime 1
set dt [new_CkDtObj]
# Iterate over each account returned.
set numRecords [CkJsonObject_SizeOfArray $json "QueryResponse.Employee"]
set i 0
while {$i < $numRecords} {
CkJsonObject_put_I $json $i
puts "DisplayName: [CkJsonObject_stringOf $json {QueryResponse.Employee[i].DisplayName}]"
puts "Id: [CkJsonObject_stringOf $json {QueryResponse.Employee[i].Id}]"
puts "Active: [CkJsonObject_BoolOf $json {QueryResponse.Employee[i].Active}]"
# Load the CreateTime into a CkDateTime...
CkDateTime_SetFromTimestamp $dtime [CkJsonObject_stringOf $json "QueryResponse.Employee[i].MetaData.CreateTime"]
CkDateTime_ToDtObj $dtime $bLocalTime $dt
puts [CkDtObj_get_Month $dt]/[CkDtObj_get_Day $dt]/[CkDtObj_get_Year $dt] [CkDtObj_get_Hour $dt]:[CkDtObj_get_Minute $dt]
# The the birth year, month, and day, if it exists.
# The BirthDate contains something like this: "1985-09-11"
if {[CkJsonObject_HasMember $json "QueryResponse.Employee[i].BirthDate"] == 1} then {
set sTab [new_CkStringTable]
CkStringTable_SplitAndAppend $sTab [CkJsonObject_stringOf $json "QueryResponse.Employee[i].BirthDate"] "-" 1 1
set year [CkStringTable_stringAt $sTab 0]
set month [CkStringTable_stringAt $sTab 1]
set day [CkStringTable_stringAt $sTab 2]
puts "BirthDate: $month/$day/$year"
}
puts "----"
set i [expr $i + 1]
}
puts "Success."
# ------------------------------------------------------
# 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"
# }
delete_CkJsonObject $jsonToken
delete_CkRest $rest
delete_CkStringBuilder $sbAuth
delete_CkJsonObject $json
delete_CkDateTime $dtime
delete_CkDtObj $dt
delete_CkStringTable $sTab