AutoIt

QuickBooks - Query an Account

See more QuickBooks Examples

Demonstrates how to query the QuickBooks chart of accounts. AutoIt

Local $bSuccess = False

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

$oJsonToken = ObjCreate("Chilkat.JsonObject")
$bSuccess = $oJsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

$oRest = ObjCreate("Chilkat.Rest")

; 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.
Local $bAutoReconnect = True
$bSuccess = $oRest.Connect("sandbox-quickbooks.api.intuit.com",443,True,$bAutoReconnect)
If ($bSuccess = False) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

$oSbAuth = ObjCreate("Chilkat.StringBuilder")
$oSbAuth.Append("Bearer ")
$oSbAuth.Append($oJsonToken.StringOf("access_token"))
$oRest.Authorization = $oSbAuth.GetAsString()

$oRest.AddHeader("Accept","application/json")
$oRest.AllowHeaderFolding = False

; Add a SELECT statement 
$oRest.AddQueryParam("query","select * from Account where Metadata.CreateTime > '2014-12-31'")
$oRest.AddQueryParam("minorversion","45")

; The company ID is 123146096291789
Local $sResponseBody = $oRest.FullRequestNoBody("GET","/v3/company/123146096291789/query")
If ($oRest.LastMethodSuccess = False) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

$oRest.ClearAllQueryParams()

; We should expect a 200 response if successful.
If ($oRest.ResponseStatusCode <> 200) Then
    ConsoleWrite("Request Header: " & @CRLF)
    ConsoleWrite($oRest.LastRequestHeader & @CRLF)
    ConsoleWrite("----" & @CRLF)
    ConsoleWrite("Response StatusCode = " & $oRest.ResponseStatusCode & @CRLF)
    ConsoleWrite("Response StatusLine: " & $oRest.ResponseStatusText & @CRLF)
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oRest.ResponseHeader & @CRLF)
    ConsoleWrite($sResponseBody & @CRLF)
    Exit
EndIf

; 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.
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.Load($sResponseBody)

; These will be used for parsing date/time strings..
$oDtime = ObjCreate("Chilkat.CkDateTime")
Local $bLocalTime = True
$oDt = ObjCreate("Chilkat.DtObj")

; Iterate over each account returned.
Local $iNumAccounts = $oJson.SizeOfArray("QueryResponse.Account")
Local $i = 0
While $i < $iNumAccounts

    $oJson.I = $i
    ConsoleWrite("Name: " & $oJson.StringOf("QueryResponse.Account[i].Name") & @CRLF)
    ConsoleWrite("Id: " & $oJson.StringOf("QueryResponse.Account[i].Id") & @CRLF)

    ; Load the CreateTime into a CkDateTime...
    $oDtime.SetFromTimestamp($oJson.StringOf("QueryResponse.Account[i].MetaData.CreateTime"))
    $oDtime.ToDtObj $bLocalTime,$oDt

    ConsoleWrite($oDt.Month & "/" & $oDt.Day & "/" & $oDt.Year & "  " & $oDt.Hour & ":" & $oDt.Minute & @CRLF)

    ConsoleWrite("----" & @CRLF)
    $i = $i + 1
Wend

ConsoleWrite("Success." & @CRLF)

; ------------------------------------------------------
; 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"
;