Tcl Requires Chilkat v11.0.0+
Tcl
QuickBooks - Query an Account
See more QuickBooks Examples
Demonstrates how to query the QuickBooks chart of accounts.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
# Add a SELECT statement
CkRest_AddQueryParam $rest "query" "select * from Account where Metadata.CreateTime > '2014-12-31'"
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
}
CkRest_ClearAllQueryParams $rest
# 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
}
# Use this online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON
# 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
set dt [new_CkDtObj]
# Iterate over each account returned.
set numAccounts [CkJsonObject_SizeOfArray $json "QueryResponse.Account"]
set i 0
while {$i < $numAccounts} {
CkJsonObject_put_I $json $i
puts "Name: [CkJsonObject_stringOf $json {QueryResponse.Account[i].Name}]"
puts "Id: [CkJsonObject_stringOf $json {QueryResponse.Account[i].Id}]"
# Load the CreateTime into a CkDateTime...
CkDateTime_SetFromTimestamp $dtime [CkJsonObject_stringOf $json "QueryResponse.Account[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]
puts "----"
set i [expr $i + 1]
}
puts "Success."
# ------------------------------------------------------
# The JSON response looks like this:
# {
# "QueryResponse": {
# "Account": [
# {
# "Name": "Accounts Payable (A/P)",
# "SubAccount": false,
# "FullyQualifiedName": "Accounts Payable (A/P)",
# "Active": true,
# "Classification": "Liability",
# "AccountType": "Accounts Payable",
# "AccountSubType": "AccountsPayable",
# "CurrentBalance": -1602.67,
# "CurrentBalanceWithSubAccounts": -1602.67,
# "CurrencyRef": {
# "value": "USD",
# "name": "United States Dollar"
# },
# "domain": "QBO",
# "sparse": false,
# "Id": "33",
# "SyncToken": "0",
# "MetaData": {
# "CreateTime": "2016-09-10T10:12:02-07:00",
# "LastUpdatedTime": "2016-09-17T13:10:36-07:00"
# }
# },
# {
# "Name": "Accounts Receivable (A/R)",
# "SubAccount": false,
# "FullyQualifiedName": "Accounts Receivable (A/R)",
# "Active": true,
# "Classification": "Asset",
# "AccountType": "Accounts Receivable",
# "AccountSubType": "AccountsReceivable",
# "CurrentBalance": 5281.52,
# "CurrentBalanceWithSubAccounts": 5281.52,
# "CurrencyRef": {
# "value": "USD",
# "name": "United States Dollar"
# },
# "domain": "QBO",
# "sparse": false,
# "Id": "84",
# "SyncToken": "0",
# "MetaData": {
# "CreateTime": "2016-09-14T14:49:29-07:00",
# "LastUpdatedTime": "2016-09-17T13:16:17-07:00"
# }
# },
# {
# "Name": "Advertising",
# "SubAccount": false,
# "FullyQualifiedName": "Advertising",
# "Active": true,
# "Classification": "Expense",
# "AccountType": "Expense",
# "AccountSubType": "AdvertisingPromotional",
# "CurrentBalance": 0,
# "CurrentBalanceWithSubAccounts": 0,
# "CurrencyRef": {
# "value": "USD",
# "name": "United States Dollar"
# },
# "domain": "QBO",
# "sparse": false,
# "Id": "7",
# "SyncToken": "0",
# "MetaData": {
# "CreateTime": "2016-09-09T14:42:07-07:00",
# "LastUpdatedTime": "2016-09-09T14:42:07-07:00"
# }
# },
# ...
# "time": "2016-10-24T15:35:25.067-07:00"
# }
delete_CkJsonObject $jsonToken
delete_CkRest $rest
delete_CkStringBuilder $sbAuth
delete_CkJsonObject $json
delete_CkDateTime $dtime
delete_CkDtObj $dt