Lua Requires Chilkat v11.0.0+

QuickBooks - Query an Account

See more QuickBooks Examples

Demonstrates how to query the QuickBooks chart of accounts. 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

-- Add a SELECT statement
rest:add_query_param("query", "select * from Account where Metadata.CreateTime > '2014-12-31'")
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

rest:clear_all_query_params()

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

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

-- Load the JSON response into a JSON object for parsing.
-- A sample JSON response is shown below.
local json = chilkat.JsonObject.new()
json:load(responseBody)

-- These will be used for parsing date/time strings..
local dtime = chilkat.DateTime.new()
local bLocalTime = true
local dt = chilkat.DtObj.new()

-- Iterate over each account returned.
local numAccounts = json:size_of_array("QueryResponse.Account")
local i = 0
while i < numAccounts do
    json.i = i
    print("Name: " .. json:string_of("QueryResponse.Account[i].Name"))
    print("Id: " .. json:string_of("QueryResponse.Account[i].Id"))

    -- Load the CreateTime into a CkDateTime...
    dtime:set_from_timestamp(json:string_of("QueryResponse.Account[i].MetaData.CreateTime"))
    dtime:to_dt_obj(bLocalTime, dt)

    print(dt.month .. "/" .. dt.day .. "/" .. dt.year .. "  " .. dt.hour .. ":" .. dt.minute)

    print("----")
    i = i + 1
end

print("Success.")

-- ------------------------------------------------------
-- The JSON response looks like this:

-- {
--   "QueryResponse": {
--     "Account": [
--       {
--         "Name": "Accounts Payable (A/P)",
--         "SubAccount": false,
--         "FullyQualifiedName": "Accounts Payable (A/P)",
--         "Active": true,
--         "Classification": "Liability",
--         "AccountType": "Accounts Payable",
--         "AccountSubType": "AccountsPayable",
--         "CurrentBalance": -1602.67,
--         "CurrentBalanceWithSubAccounts": -1602.67,
--         "CurrencyRef": {
--           "value": "USD",
--           "name": "United States Dollar"
--         },
--         "domain": "QBO",
--         "sparse": false,
--         "Id": "33",
--         "SyncToken": "0",
--         "MetaData": {
--           "CreateTime": "2016-09-10T10:12:02-07:00",
--           "LastUpdatedTime": "2016-09-17T13:10:36-07:00"
--         }
--       },
--       {
--         "Name": "Accounts Receivable (A/R)",
--         "SubAccount": false,
--         "FullyQualifiedName": "Accounts Receivable (A/R)",
--         "Active": true,
--         "Classification": "Asset",
--         "AccountType": "Accounts Receivable",
--         "AccountSubType": "AccountsReceivable",
--         "CurrentBalance": 5281.52,
--         "CurrentBalanceWithSubAccounts": 5281.52,
--         "CurrencyRef": {
--           "value": "USD",
--           "name": "United States Dollar"
--         },
--         "domain": "QBO",
--         "sparse": false,
--         "Id": "84",
--         "SyncToken": "0",
--         "MetaData": {
--           "CreateTime": "2016-09-14T14:49:29-07:00",
--           "LastUpdatedTime": "2016-09-17T13:16:17-07:00"
--         }
--       },
--       {
--         "Name": "Advertising",
--         "SubAccount": false,
--         "FullyQualifiedName": "Advertising",
--         "Active": true,
--         "Classification": "Expense",
--         "AccountType": "Expense",
--         "AccountSubType": "AdvertisingPromotional",
--         "CurrentBalance": 0,
--         "CurrentBalanceWithSubAccounts": 0,
--         "CurrencyRef": {
--           "value": "USD",
--           "name": "United States Dollar"
--         },
--         "domain": "QBO",
--         "sparse": false,
--         "Id": "7",
--         "SyncToken": "0",
--         "MetaData": {
--           "CreateTime": "2016-09-09T14:42:07-07:00",
--           "LastUpdatedTime": "2016-09-09T14:42:07-07:00"
--         }
--       },
-- ...
--   "time": "2016-10-24T15:35:25.067-07:00"
-- }