Xojo Plugin

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

Xojo Plugin

Dim success As Boolean
success = 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"
// }

Dim jsonToken As New Chilkat.JsonObject
success = jsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

Dim rest As New 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.
Dim bAutoReconnect As Boolean
bAutoReconnect = True
success = rest.Connect("sandbox-quickbooks.api.intuit.com",443,True,bAutoReconnect)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

Dim sbAuth As New Chilkat.StringBuilder
success = sbAuth.Append("Bearer ")
success = sbAuth.Append(jsonToken.StringOf("access_token"))
rest.Authorization = sbAuth.GetAsString()

success = rest.AddHeader("Accept","application/json")
rest.AllowHeaderFolding = False

Dim query As String
query = "select * from Customer"
success = rest.AddQueryParam("query",query)
success = rest.AddQueryParam("minorversion","45")

// The company ID is 123146096291789
Dim responseBody As String
responseBody = rest.FullRequestNoBody("GET","/v3/company/123146096291789/query")
If (rest.LastMethodSuccess <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

// We should expect a 200 response if successful.
If (rest.ResponseStatusCode <> 200) Then
    System.DebugLog("Request Header: ")
    System.DebugLog(rest.LastRequestHeader)
    System.DebugLog("----")
    System.DebugLog("Response StatusCode = " + Str(rest.ResponseStatusCode))
    System.DebugLog("Response StatusLine: " + rest.ResponseStatusText)
    System.DebugLog("Response Header:")
    System.DebugLog(rest.ResponseHeader)
    System.DebugLog(responseBody)
    Return
End If

// Load the JSON response into a JSON object for parsing.
// A sample JSON response is shown below.
Dim json As New Chilkat.JsonObject
json.EmitCompact = False
success = json.Load(responseBody)

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

// Iterate over each customer returned.
Dim numRecords As Int32
numRecords = json.SizeOfArray("QueryResponse.Customer")
Dim i As Int32
i = 0
While i < numRecords

    json.I = i
    System.DebugLog("Name: " + json.StringOf("QueryResponse.Customer[i].FullyQualifiedName"))
    System.DebugLog("Id: " + json.StringOf("QueryResponse.Customer[i].Id"))
    System.DebugLog("City: " + json.StringOf("QueryResponse.Customer[i].BillAddr.City"))
    System.DebugLog("----")
    i = i + 1
Wend

System.DebugLog("Success.")