Lua Requires Chilkat v11.0.0+
Lua
QuickBooks - Query Employees
See more QuickBooks Examples
Demonstrates how to query the QuickBooks employee data.Chilkat Lua Downloads
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 Employee"
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:load(responseBody)
-- Show the full JSON response.
json.emit_compact = false
print(json:emit())
-- Use this online tool to generate parsing code from sample JSON:
-- Generate Parsing Code from JSON
-- 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 numRecords = json:size_of_array("QueryResponse.Employee")
local i = 0
while i < numRecords do
json.i = i
print("DisplayName: " .. json:string_of("QueryResponse.Employee[i].DisplayName"))
print("Id: " .. json:string_of("QueryResponse.Employee[i].Id"))
print("Active: " .. tostring(json:bool_of("QueryResponse.Employee[i].Active")))
-- Load the CreateTime into a CkDateTime...
dtime:set_from_timestamp(json:string_of("QueryResponse.Employee[i].MetaData.CreateTime"))
dtime:to_dt_obj(bLocalTime, dt)
print(dt.month .. "/" .. dt.day .. "/" .. dt.year .. " " .. dt.hour .. ":" .. dt.minute)
-- The the birth year, month, and day, if it exists.
-- The BirthDate contains something like this: "1985-09-11"
if json:has_member("QueryResponse.Employee[i].BirthDate") then
local sTab = chilkat.StringTable.new()
sTab:split_and_append(json:string_of("QueryResponse.Employee[i].BirthDate"), "-", true, true)
local year = sTab:string_at(0)
local month = sTab:string_at(1)
local day = sTab:string_at(2)
print("BirthDate: " .. month .. "/" .. day .. "/" .. year)
end
print("----")
i = i + 1
end
print("Success.")
-- ------------------------------------------------------
-- The JSON response looks like this:
-- {
-- "QueryResponse": {
-- "Employee": [
-- {
-- "BillableTime": false,
-- "domain": "QBO",
-- "sparse": false,
-- "Id": "55",
-- "SyncToken": "0",
-- "MetaData": {
-- "CreateTime": "2016-09-15T11:21:48-07:00",
-- "LastUpdatedTime": "2016-09-15T11:21:48-07:00"
-- },
-- "GivenName": "Emily",
-- "FamilyName": "Platt",
-- "DisplayName": "Emily Platt",
-- "PrintOnCheckName": "Emily Platt",
-- "Active": true
-- },
-- {
-- "BillableTime": false,
-- "BirthDate": "1985-09-11",
-- "HiredDate": "2016-08-17",
-- "domain": "QBO",
-- "sparse": false,
-- "Id": "54",
-- "SyncToken": "1",
-- "MetaData": {
-- "CreateTime": "2016-09-15T11:21:28-07:00",
-- "LastUpdatedTime": "2016-09-15T11:46:26-07:00"
-- },
-- "GivenName": "John",
-- "FamilyName": "Johnson",
-- "DisplayName": "John Johnson",
-- "PrintOnCheckName": "John Johnson",
-- "Active": true,
-- "PrimaryPhone": {
-- "FreeFormNumber": "(540) 555-9645"
-- }
-- },
-- {
-- "SSN": "XXX-XX-XXXX",
-- "PrimaryAddr": {
-- "Id": "98",
-- "Line1": "45 N. Elm Street",
-- "City": "Middlefield",
-- "CountrySubDivisionCode": "CA",
-- "PostalCode": "93242"
-- },
-- "BillableTime": false,
-- "domain": "QBO",
-- "sparse": false,
-- "Id": "60",
-- "SyncToken": "0",
-- "MetaData": {
-- "CreateTime": "2016-10-25T14:08:18-07:00",
-- "LastUpdatedTime": "2016-10-25T14:08:18-07:00"
-- },
-- "GivenName": "John",
-- "FamilyName": "Meuller",
-- "DisplayName": "John Meuller",
-- "PrintOnCheckName": "John Meuller",
-- "Active": true,
-- "PrimaryPhone": {
-- "FreeFormNumber": "408-525-1234"
-- }
-- }
-- ],
-- "startPosition": 1,
-- "maxResults": 3
-- },
-- "time": "2016-10-25T14:18:38.487-07:00"
-- }