Lua

QuickBooks - Create an Employee

See more QuickBooks Examples

Demonstrates how to send an JSON request to create a QuickBooks employee 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()

-- Create the following JSON:

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

-- {
--   "SSN": "444-55-6666",
--   "PrimaryAddr": {
--     "Id": "50",
--     "Line1": "45 N. Elm Street",
--     "City": "Middlefield",
--     "CountrySubDivisionCode": "CA",
--     "PostalCode": "93242"
--   },
--   "GivenName": "John",
--   "FamilyName": "Meuller",
--   "PrimaryPhone": {
--     "FreeFormNumber": "408-525-1234"
--   }
-- }
--
local json = chilkat.JsonObject.new()
json:update_string("SSN", "444-55-6666")
json:update_string("PrimaryAddr.Id", "50")
json:update_string("PrimaryAddr.Line1", "45 N. Elm Street")
json:update_string("PrimaryAddr.City", "Middlefield")
json:update_string("PrimaryAddr.CountrySubDivisionCode", "CA")
json:update_string("PrimaryAddr.PostalCode", "93242")
json:update_string("GivenName", "John")
json:update_string("FamilyName", "Meuller")
json:update_string("PrimaryPhone.FreeFormNumber", "408-525-1234")

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

-- The company ID is 123146096291789
local responseBody = rest:full_request_string("POST", "/v3/company/123146096291789/employee?minorversion=45", json:emit())
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

local jsonResponse = chilkat.JsonObject.new()
jsonResponse:load(responseBody)
jsonResponse.emit_compact = false
print(jsonResponse:emit())
print("Success.")

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

-- A sample JSON response:
-- {
--   "Employee": {
--     "SSN": "XXX-XX-XXXX",
--     "PrimaryAddr": {
--       "Id": "97",
--       "Line1": "45 N. Elm Street",
--       "City": "Middlefield",
--       "CountrySubDivisionCode": "CA",
--       "PostalCode": "93242"
--     },
--     "BillableTime": false,
--     "domain": "QBO",
--     "sparse": false,
--     "Id": "59",
--     "SyncToken": "0",
--     "MetaData": {
--       "CreateTime": "2016-10-25T14:05:05-07:00",
--       "LastUpdatedTime": "2016-10-25T14:05:05-07:00"
--     },
--     "GivenName": "John",
--     "FamilyName": "Meuller",
--     "DisplayName": "John Meuller",
--     "PrintOnCheckName": "John Meuller",
--     "Active": true,
--     "PrimaryPhone": {
--       "FreeFormNumber": "408-525-1234"
--     }
--   },
--   "time": "2016-10-25T14:05:05.661-07:00"
-- }
--