VBScript

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

VBScript

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

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 = CreateObject("Chilkat.JsonObject")
success = jsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

set rest = CreateObject("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.
bAutoReconnect = 1
success = rest.Connect("sandbox-quickbooks.api.intuit.com",443,1,bAutoReconnect)
If (success <> 1) Then
    outFile.WriteLine(rest.LastErrorText)
    WScript.Quit
End If

set sbAuth = CreateObject("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 = 0

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

' The company ID is 123146096291789
responseBody = rest.FullRequestNoBody("GET","/v3/company/123146096291789/query")
If (rest.LastMethodSuccess <> 1) Then
    outFile.WriteLine(rest.LastErrorText)
    WScript.Quit
End If

' We should expect a 200 response if successful.
If (rest.ResponseStatusCode <> 200) Then
    outFile.WriteLine("Request Header: ")
    outFile.WriteLine(rest.LastRequestHeader)
    outFile.WriteLine("----")
    outFile.WriteLine("Response StatusCode = " & rest.ResponseStatusCode)
    outFile.WriteLine("Response StatusLine: " & rest.ResponseStatusText)
    outFile.WriteLine("Response Header:")
    outFile.WriteLine(rest.ResponseHeader)
    outFile.WriteLine(responseBody)
    WScript.Quit
End If

' Load the JSON response into a JSON object for parsing.
' A sample JSON response is shown below.
set json = CreateObject("Chilkat.JsonObject")
json.EmitCompact = 0
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.
numRecords = json.SizeOfArray("QueryResponse.Customer")
i = 0
Do While i < numRecords

    json.I = i
    outFile.WriteLine("Name: " & json.StringOf("QueryResponse.Customer[i].FullyQualifiedName"))
    outFile.WriteLine("Id: " & json.StringOf("QueryResponse.Customer[i].Id"))
    outFile.WriteLine("City: " & json.StringOf("QueryResponse.Customer[i].BillAddr.City"))
    outFile.WriteLine("----")
    i = i + 1
Loop

outFile.WriteLine("Success.")

outFile.Close