AutoIt

QuickBooks - Query a Customer

See more QuickBooks Examples

Demonstrates how to query QuickBooks customers.

A sample JSON response body is available at Sample Quickbooks Customer Query JSON Response

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 <> True) 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

Local $sQuery = "select * from Customer"
$oRest.AddQueryParam("query",$sQuery)
$oRest.AddQueryParam("minorversion","45")

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

; 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

; Load the JSON response into a JSON object for parsing.
; A sample JSON response is shown below.
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.EmitCompact = False
$oJson.Load($sResponseBody)

; Use this online tool to generate parsing code from sample JSON: 
; Generate Parsing Code from JSON

; Iterate over each customer returned.
Local $iNumRecords = $oJson.SizeOfArray("QueryResponse.Customer")
Local $i = 0
While $i < $iNumRecords

    $oJson.I = $i
    ConsoleWrite("Name: " & $oJson.StringOf("QueryResponse.Customer[i].FullyQualifiedName") & @CRLF)
    ConsoleWrite("Id: " & $oJson.StringOf("QueryResponse.Customer[i].Id") & @CRLF)
    ConsoleWrite("City: " & $oJson.StringOf("QueryResponse.Customer[i].BillAddr.City") & @CRLF)
    ConsoleWrite("----" & @CRLF)
    $i = $i + 1
Wend

ConsoleWrite("Success." & @CRLF)