Lua

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

Lua

local chilkat = require("chilkat")

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

local jsonToken = chilkat.JsonObject.new()
local success = jsonToken:load_file("qa_data/tokens/qb-access-token.json")

local rest = chilkat.Rest.new()

-- 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
success = rest:connect("sandbox-quickbooks.api.intuit.com", 443, true, bAutoReconnect)
if not success then
    print(rest.last_error_text)
    return
end

local sbAuth = chilkat.StringBuilder.new()
sbAuth:append("Bearer ")
sbAuth:append(jsonToken:string_of("access_token"))
rest.authorization = sbAuth:get_as_string()

rest:add_header("Accept", "application/json")
rest.allow_header_folding = false

local query = "select * from Customer"
rest:add_query_param("query", query)
rest:add_query_param("minorversion", "45")

-- The company ID is 123146096291789
local responseBody = rest:full_request_no_body("GET", "/v3/company/123146096291789/query")
if not rest.last_method_success then
    print(rest.last_error_text)
    return
end

-- We should expect a 200 response if successful.
if rest.response_status_code ~= 200 then
    print("Request Header: ")
    print(rest.last_request_header)
    print("----")
    print("Response StatusCode = " .. rest.response_status_code)
    print("Response StatusLine: " .. rest.response_status_text)
    print("Response Header:")
    print(rest.response_header)
    print(responseBody)
    return
end

-- Load the JSON response into a JSON object for parsing.
-- A sample JSON response is shown below.
local json = chilkat.JsonObject.new()
json.emit_compact = 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.
local numRecords = json:size_of_array("QueryResponse.Customer")
local i = 0
while i < numRecords do
    json.i = i
    print("Name: " .. json:string_of("QueryResponse.Customer[i].FullyQualifiedName"))
    print("Id: " .. json:string_of("QueryResponse.Customer[i].Id"))
    print("City: " .. json:string_of("QueryResponse.Customer[i].BillAddr.City"))
    print("----")
    i = i + 1
end

print("Success.")