Lua

QuickBooks - Read an Employee (with Error Response)

See more QuickBooks Examples

Demonstrates how to fetch the information for a specific Quickbooks employee, but tries to fetch using an invalid employee id. Shows the error response and how to parse it. 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

-- The company ID is 123146096291789
-- The employee ID is 999  (There is no employee with this ID and we should get a 400 response code w/ a response body indicating the error.)
local responseBody = rest:full_request_no_body("GET", "/v3/company/123146096291789/employee/999?minorversion=45")
if not rest.last_method_success then
    print(rest.last_error_text)
    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:load(responseBody)
json.emit_compact = false
print(json:emit())

-- A 400 response is what we'd expect if trying to query for a non-existent employee ID
if rest.response_status_code ~= 400 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)
    return
end

-- If we got here, the response status code was 400..
-- Iterate over the errors..
local numErrors = json:size_of_array("Fault.Error")
local i = 0
while i < numErrors do
    json.i = i
    print("Message: " .. json:string_of("Fault.Error[i].Message"))
    print("Detail: " .. json:string_of("Fault.Error[i].Detail"))
    print("code: " .. json:string_of("Fault.Error[i].code"))
    print("----")
    i = i + 1
end

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

-- {
--   "Fault": {
--     "Error": [
--       {
--         "Message": "Object Not Found",
--         "Detail": "Object Not Found : Something you're trying to use has been made inactive. Check the fields with accounts, customers, items, vendors or employees.",
--         "code": "610",
--         "element": ""
--       }
--     ],
--     "type": "ValidationFault"
--   },
--   "time": "2020-03-07T10:21:19.089-08:00"
-- }