Tcl

QuickBooks - Create an Employee

See more QuickBooks Examples

Demonstrates how to send an JSON request to create a QuickBooks employee Tcl

load ./chilkat.dll

set success 0

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

set jsonToken [new_CkJsonObject]

set success [CkJsonObject_LoadFile $jsonToken "qa_data/tokens/qb-access-token.json"]

set rest [new_CkRest]

# 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.
set bAutoReconnect 1
set success [CkRest_Connect $rest "sandbox-quickbooks.api.intuit.com" 443 1 $bAutoReconnect]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkRest $rest
    exit
}

set sbAuth [new_CkStringBuilder]

CkStringBuilder_Append $sbAuth "Bearer "
CkStringBuilder_Append $sbAuth [CkJsonObject_stringOf $jsonToken "access_token"]
CkRest_put_Authorization $rest [CkStringBuilder_getAsString $sbAuth]

# 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"
#   }
# }
# 
set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "SSN" "444-55-6666"
CkJsonObject_UpdateString $json "PrimaryAddr.Id" "50"
CkJsonObject_UpdateString $json "PrimaryAddr.Line1" "45 N. Elm Street"
CkJsonObject_UpdateString $json "PrimaryAddr.City" "Middlefield"
CkJsonObject_UpdateString $json "PrimaryAddr.CountrySubDivisionCode" "CA"
CkJsonObject_UpdateString $json "PrimaryAddr.PostalCode" "93242"
CkJsonObject_UpdateString $json "GivenName" "John"
CkJsonObject_UpdateString $json "FamilyName" "Meuller"
CkJsonObject_UpdateString $json "PrimaryPhone.FreeFormNumber" "408-525-1234"

CkRest_AddHeader $rest "Content-Type" "application/json"
CkRest_AddHeader $rest "Accept" "application/json"
CkRest_put_AllowHeaderFolding $rest 0

# The company ID is 123146096291789
set responseBody [CkRest_fullRequestString $rest "POST" "/v3/company/123146096291789/employee?minorversion=45" [CkJsonObject_emit $json]]
if {[CkRest_get_LastMethodSuccess $rest] != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkRest $rest
    delete_CkStringBuilder $sbAuth
    delete_CkJsonObject $json
    exit
}

# We should expect a 200 response if successful.
if {[CkRest_get_ResponseStatusCode $rest] != 200} then {
    puts "Request Header: "
    puts [CkRest_lastRequestHeader $rest]
    puts "----"
    puts "Response StatusCode = [CkRest_get_ResponseStatusCode $rest]"
    puts "Response StatusLine: [CkRest_responseStatusText $rest]"
    puts "Response Header:"
    puts [CkRest_responseHeader $rest]
    puts "$responseBody"
    delete_CkJsonObject $jsonToken
    delete_CkRest $rest
    delete_CkStringBuilder $sbAuth
    delete_CkJsonObject $json
    exit
}

set jsonResponse [new_CkJsonObject]

CkJsonObject_Load $jsonResponse $responseBody
CkJsonObject_put_EmitCompact $jsonResponse 0
puts [CkJsonObject_emit $jsonResponse]
puts "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"
# }
# 

delete_CkJsonObject $jsonToken
delete_CkRest $rest
delete_CkStringBuilder $sbAuth
delete_CkJsonObject $json
delete_CkJsonObject $jsonResponse