Swift
Swift
QuickBooks - Query Employees
See more QuickBooks Examples
Demonstrates how to query the QuickBooks employee data.Chilkat Swift Downloads
func chilkatTest() {
var success: Bool = false
// 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"
// }
let jsonToken = CkoJsonObject()!
success = jsonToken.loadFile(path: "qa_data/tokens/qb-access-token.json")
let rest = CkoRest()!
// 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.
var bAutoReconnect: Bool = true
success = rest.connect(hostname: "sandbox-quickbooks.api.intuit.com", port: 443, tls: true, autoReconnect: bAutoReconnect)
if success == false {
print("\(rest.lastErrorText!)")
return
}
let sbAuth = CkoStringBuilder()!
sbAuth.append(value: "Bearer ")
sbAuth.append(value: jsonToken.string(of: "access_token"))
rest.authorization = sbAuth.getAsString()
rest.addHeader(name: "Accept", value: "application/json")
rest.allowHeaderFolding = false
var query: String? = "select * from Employee"
rest.addQueryParam(name: "query", value: query)
rest.addQueryParam(name: "minorversion", value: "45")
// The company ID is 123146096291789
var responseBody: String? = rest.fullRequestNoBody(httpVerb: "GET", uriPath: "/v3/company/123146096291789/query")
if rest.lastMethodSuccess == false {
print("\(rest.lastErrorText!)")
return
}
// We should expect a 200 response if successful.
if rest.responseStatusCode.intValue != 200 {
print("Request Header: ")
print("\(rest.lastRequestHeader!)")
print("----")
print("Response StatusCode = \(rest.responseStatusCode.intValue)")
print("Response StatusLine: \(rest.responseStatusText!)")
print("Response Header:")
print("\(rest.responseHeader!)")
print("\(responseBody!)")
return
}
// Load the JSON response into a JSON object for parsing.
// A sample JSON response is shown below.
let json = CkoJsonObject()!
json.load(json: responseBody)
// Show the full JSON response.
json.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..
let dtime = CkoDateTime()!
var bLocalTime: Bool = true
let dt = CkoDtObj()!
// Iterate over each account returned.
var numRecords: Int = json.size(ofArray: "QueryResponse.Employee").intValue
var i: Int = 0
while i < numRecords {
json.i = i
print("DisplayName: \(json.string(of: "QueryResponse.Employee[i].DisplayName")!)")
print("Id: \(json.string(of: "QueryResponse.Employee[i].Id")!)")
print("Active: \(json.bool(of: "QueryResponse.Employee[i].Active"))")
// Load the CreateTime into a CkDateTime...
dtime.set(fromTimestamp: json.string(of: "QueryResponse.Employee[i].MetaData.CreateTime"))
dtime.toDtObj(bLocal: bLocalTime, dtObj: dt)
print("\(dt.month.intValue)/\(dt.day.intValue)/\(dt.year.intValue) \(dt.hour.intValue):\(dt.minute.intValue)")
// The the birth year, month, and day, if it exists.
// The BirthDate contains something like this: "1985-09-11"
if json.hasMember(jsonPath: "QueryResponse.Employee[i].BirthDate") == true {
let sTab = CkoStringTable()!
sTab.splitAndAppend(inStr: json.string(of: "QueryResponse.Employee[i].BirthDate"), delimiterChar: "-", exceptDoubleQuoted: true, exceptEscaped: true)
var year: String? = sTab.string(at: 0)
var month: String? = sTab.string(at: 1)
var day: String? = sTab.string(at: 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"
//
}