Swift

QuickBooks - Query a Customer

See more QuickBooks Examples

Demonstrates how to query QuickBooks customers.

A sample JSON response body is available at Sample Quickbooks Customer Query JSON Response

Swift

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 != true {
        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 Customer"
    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 != true {
        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.emitCompact = false
    json.load(json: responseBody)

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

    // Iterate over each customer returned.
    var numRecords: Int = json.size(ofArray: "QueryResponse.Customer").intValue
    var i: Int = 0
    while i < numRecords {

        json.i = i
        print("Name: \(json.string(of: "QueryResponse.Customer[i].FullyQualifiedName")!)")
        print("Id: \(json.string(of: "QueryResponse.Customer[i].Id")!)")
        print("City: \(json.string(of: "QueryResponse.Customer[i].BillAddr.City")!)")
        print("----")
        i = i + 1
    }

    print("Success.")

}