PureBasic
PureBasic
QuickBooks - Query Employees
See more QuickBooks Examples
Demonstrates how to query the QuickBooks employee data.Chilkat PureBasic Downloads
IncludeFile "CkJsonObject.pb"
IncludeFile "CkDateTime.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkStringTable.pb"
IncludeFile "CkDtObj.pb"
Procedure ChilkatExample()
success.i = 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"
; }
jsonToken.i = CkJsonObject::ckCreate()
If jsonToken.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/qb-access-token.json")
rest.i = CkRest::ckCreate()
If rest.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; 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.i = 1
success = CkRest::ckConnect(rest,"sandbox-quickbooks.api.intuit.com",443,1,bAutoReconnect)
If success = 0
Debug CkRest::ckLastErrorText(rest)
CkJsonObject::ckDispose(jsonToken)
CkRest::ckDispose(rest)
ProcedureReturn
EndIf
sbAuth.i = CkStringBuilder::ckCreate()
If sbAuth.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkStringBuilder::ckAppend(sbAuth,"Bearer ")
CkStringBuilder::ckAppend(sbAuth,CkJsonObject::ckStringOf(jsonToken,"access_token"))
CkRest::setCkAuthorization(rest, CkStringBuilder::ckGetAsString(sbAuth))
CkRest::ckAddHeader(rest,"Accept","application/json")
CkRest::setCkAllowHeaderFolding(rest, 0)
query.s = "select * from Employee"
CkRest::ckAddQueryParam(rest,"query",query)
CkRest::ckAddQueryParam(rest,"minorversion","45")
; The company ID is 123146096291789
responseBody.s = CkRest::ckFullRequestNoBody(rest,"GET","/v3/company/123146096291789/query")
If CkRest::ckLastMethodSuccess(rest) = 0
Debug CkRest::ckLastErrorText(rest)
CkJsonObject::ckDispose(jsonToken)
CkRest::ckDispose(rest)
CkStringBuilder::ckDispose(sbAuth)
ProcedureReturn
EndIf
; We should expect a 200 response if successful.
If CkRest::ckResponseStatusCode(rest) <> 200
Debug "Request Header: "
Debug CkRest::ckLastRequestHeader(rest)
Debug "----"
Debug "Response StatusCode = " + Str(CkRest::ckResponseStatusCode(rest))
Debug "Response StatusLine: " + CkRest::ckResponseStatusText(rest)
Debug "Response Header:"
Debug CkRest::ckResponseHeader(rest)
Debug responseBody
CkJsonObject::ckDispose(jsonToken)
CkRest::ckDispose(rest)
CkStringBuilder::ckDispose(sbAuth)
ProcedureReturn
EndIf
; Load the JSON response into a JSON object for parsing.
; A sample JSON response is shown below.
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoad(json,responseBody)
; Show the full JSON response.
CkJsonObject::setCkEmitCompact(json, 0)
Debug CkJsonObject::ckEmit(json)
; 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.i = CkDateTime::ckCreate()
If dtime.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
bLocalTime.i = 1
dt.i = CkDtObj::ckCreate()
If dt.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; Iterate over each account returned.
numRecords.i = CkJsonObject::ckSizeOfArray(json,"QueryResponse.Employee")
i.i = 0
While i < numRecords
CkJsonObject::setCkI(json, i)
Debug "DisplayName: " + CkJsonObject::ckStringOf(json,"QueryResponse.Employee[i].DisplayName")
Debug "Id: " + CkJsonObject::ckStringOf(json,"QueryResponse.Employee[i].Id")
Debug "Active: " + Str(CkJsonObject::ckBoolOf(json,"QueryResponse.Employee[i].Active"))
; Load the CreateTime into a CkDateTime...
CkDateTime::ckSetFromTimestamp(dtime,CkJsonObject::ckStringOf(json,"QueryResponse.Employee[i].MetaData.CreateTime"))
CkDateTime::ckToDtObj(dtime,bLocalTime,dt)
Debug Str(CkDtObj::ckMonth(dt)) + "/" + Str(CkDtObj::ckDay(dt)) + "/" + Str(CkDtObj::ckYear(dt)) + " " + Str(CkDtObj::ckHour(dt)) + ":" + Str(CkDtObj::ckMinute(dt))
; The the birth year, month, and day, if it exists.
; The BirthDate contains something like this: "1985-09-11"
If CkJsonObject::ckHasMember(json,"QueryResponse.Employee[i].BirthDate") = 1
sTab.i = CkStringTable::ckCreate()
If sTab.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkStringTable::ckSplitAndAppend(sTab,CkJsonObject::ckStringOf(json,"QueryResponse.Employee[i].BirthDate"),"-",1,1)
year.s = CkStringTable::ckStringAt(sTab,0)
month.s = CkStringTable::ckStringAt(sTab,1)
day.s = CkStringTable::ckStringAt(sTab,2)
Debug "BirthDate: " + month + "/" + day + "/" + year
EndIf
Debug "----"
i = i + 1
Wend
Debug "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"
;
CkJsonObject::ckDispose(jsonToken)
CkRest::ckDispose(rest)
CkStringBuilder::ckDispose(sbAuth)
CkJsonObject::ckDispose(json)
CkDateTime::ckDispose(dtime)
CkDtObj::ckDispose(dt)
CkStringTable::ckDispose(sTab)
ProcedureReturn
EndProcedure