(PowerShell) QuickBooks - Query a Customer

Demonstrates how to query QuickBooks customers.

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

For more information, see https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/customer#query-a-customer

Chilkat .NET Downloads Chilkat .NET Assemblies

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

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

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

$rest = New-Object 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 = $true
$success = $rest.Connect("sandbox-quickbooks.api.intuit.com",443,$true,$bAutoReconnect)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

$sbAuth = New-Object Chilkat.StringBuilder
$sbAuth.Append("Bearer ")
$sbAuth.Append($jsonToken.StringOf("access_token"))
$rest.Authorization = $sbAuth.GetAsString()

$rest.AddHeader("Accept","application/json")
$rest.AllowHeaderFolding = $false

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

# The company ID is 123146096291789
$responseBody = $rest.FullRequestNoBody("GET","/v3/company/123146096291789/query")
if ($rest.LastMethodSuccess -ne $true) {
    $($rest.LastErrorText)
    exit
}

# We should expect a 200 response if successful.
if ($rest.ResponseStatusCode -ne 200) {
    $("Request Header: ")
    $($rest.LastRequestHeader)
    $("----")
    $("Response StatusCode = " + $rest.ResponseStatusCode)
    $("Response StatusLine: " + $rest.ResponseStatusText)
    $("Response Header:")
    $($rest.ResponseHeader)
    $($responseBody)
    exit
}

# Load the JSON response into a JSON object for parsing.
# A sample JSON response is shown below.
$json = New-Object Chilkat.JsonObject
$json.EmitCompact = $false
$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
while ($i -lt $numRecords) {

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

$("Success.")