C++

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

C++

#include <CkJsonObject.h>
#include <CkRest.h>
#include <CkStringBuilder.h>

void ChilkatSample(void)
    {
    bool success = 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"
    //  }

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

    CkRest rest;

    //  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.
    bool bAutoReconnect = true;
    success = rest.Connect("sandbox-quickbooks.api.intuit.com",443,true,bAutoReconnect);
    if (success != true) {
        std::cout << rest.lastErrorText() << "\r\n";
        return;
    }

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

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

    const char *query = "select * from Customer";
    rest.AddQueryParam("query",query);
    rest.AddQueryParam("minorversion","45");

    //  The company ID is 123146096291789
    const char *responseBody = rest.fullRequestNoBody("GET","/v3/company/123146096291789/query");
    if (rest.get_LastMethodSuccess() != true) {
        std::cout << rest.lastErrorText() << "\r\n";
        return;
    }

    //  We should expect a 200 response if successful.
    if (rest.get_ResponseStatusCode() != 200) {
        std::cout << "Request Header: " << "\r\n";
        std::cout << rest.lastRequestHeader() << "\r\n";
        std::cout << "----" << "\r\n";
        std::cout << "Response StatusCode = " << rest.get_ResponseStatusCode() << "\r\n";
        std::cout << "Response StatusLine: " << rest.responseStatusText() << "\r\n";
        std::cout << "Response Header:" << "\r\n";
        std::cout << rest.responseHeader() << "\r\n";
        std::cout << responseBody << "\r\n";
        return;
    }

    //  Load the JSON response into a JSON object for parsing.
    //  A sample JSON response is shown below.
    CkJsonObject json;
    json.put_EmitCompact(false);
    json.Load(responseBody);

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

    //  Iterate over each customer returned.
    int numRecords = json.SizeOfArray("QueryResponse.Customer");
    int i = 0;
    while (i < numRecords) {

        json.put_I(i);
        std::cout << "Name: " << json.stringOf("QueryResponse.Customer[i].FullyQualifiedName") << "\r\n";
        std::cout << "Id: " << json.stringOf("QueryResponse.Customer[i].Id") << "\r\n";
        std::cout << "City: " << json.stringOf("QueryResponse.Customer[i].BillAddr.City") << "\r\n";
        std::cout << "----" << "\r\n";
        i = i + 1;
    }

    std::cout << "Success." << "\r\n";
    }