(CkPython) QuickBooks - Query Employees

Demonstrates how to query the QuickBooks employee data.

For more information, see https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/employee#query-an-employee

Chilkat Python Downloads install with pip pip3 install chilkat or download... Python Module for Windows, MacOS, Linux, Alpine Linux, Solaris

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

jsonToken = chilkat.CkJsonObject()
success = jsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

rest = chilkat.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.
bAutoReconnect = True
success = rest.Connect("sandbox-quickbooks.api.intuit.com",443,True,bAutoReconnect)
if (success != True):
    print(rest.lastErrorText())
    sys.exit()

sbAuth = chilkat.CkStringBuilder()
sbAuth.Append("Bearer ")
sbAuth.Append(jsonToken.stringOf("access_token"))
rest.put_Authorization(sbAuth.getAsString())

rest.AddHeader("Accept","application/json")
rest.put_AllowHeaderFolding(False)

query = "select * from Employee"
rest.AddQueryParam("query",query)
rest.AddQueryParam("minorversion","45")

# The company ID is 123146096291789
responseBody = rest.fullRequestNoBody("GET","/v3/company/123146096291789/query")
if (rest.get_LastMethodSuccess() != True):
    print(rest.lastErrorText())
    sys.exit()

# We should expect a 200 response if successful.
if (rest.get_ResponseStatusCode() != 200):
    print("Request Header: ")
    print(rest.lastRequestHeader())
    print("----")
    print("Response StatusCode = " + str(rest.get_ResponseStatusCode()))
    print("Response StatusLine: " + rest.responseStatusText())
    print("Response Header:")
    print(rest.responseHeader())
    print(responseBody)
    sys.exit()

# Load the JSON response into a JSON object for parsing.
# A sample JSON response is shown below.
json = chilkat.CkJsonObject()
json.Load(responseBody)

# Show the full JSON response.
json.put_EmitCompact(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..
dtime = chilkat.CkDateTime()
bLocalTime = True

# Iterate over each account returned.
numRecords = json.SizeOfArray("QueryResponse.Employee")
i = 0
while i < numRecords :

    json.put_I(i)
    print("DisplayName: " + json.stringOf("QueryResponse.Employee[i].DisplayName"))
    print("Id: " + json.stringOf("QueryResponse.Employee[i].Id"))
    print("Active: " + str(json.BoolOf("QueryResponse.Employee[i].Active")))

    # Load the CreateTime into a CkDateTime...
    dtime.SetFromTimestamp(json.stringOf("QueryResponse.Employee[i].MetaData.CreateTime"))
    # dt is a CkDtObj
    dt = dtime.GetDtObj(bLocalTime)
    print(str(dt.get_Month()) + "/" + str(dt.get_Day()) + "/" + str(dt.get_Year()) + "  " + str(dt.get_Hour())\
         + ":" + str(dt.get_Minute()))

    # The the birth year, month, and day, if it exists.
    # The BirthDate contains something like this: "1985-09-11"
    if (json.HasMember("QueryResponse.Employee[i].BirthDate") == True):
        sTab = chilkat.CkStringTable()
        sTab.SplitAndAppend(json.stringOf("QueryResponse.Employee[i].BirthDate"),"-",True,True)
        year = sTab.stringAt(0)
        month = sTab.stringAt(1)
        day = sTab.stringAt(2)
        print("BirthDate: " + month + "/" + day + "/" + year)

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

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