Unicode 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

Unicode C

#include <C_CkJsonObjectW.h>
#include <C_CkRestW.h>
#include <C_CkStringBuilderW.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkJsonObjectW jsonToken;
    HCkRestW rest;
    BOOL bAutoReconnect;
    HCkStringBuilderW sbAuth;
    const wchar_t *query;
    const wchar_t *responseBody;
    HCkJsonObjectW json;
    int numRecords;
    int i;

    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"
    // }

    jsonToken = CkJsonObjectW_Create();
    success = CkJsonObjectW_LoadFile(jsonToken,L"qa_data/tokens/qb-access-token.json");

    rest = CkRestW_Create();

    // 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 = CkRestW_Connect(rest,L"sandbox-quickbooks.api.intuit.com",443,TRUE,bAutoReconnect);
    if (success != TRUE) {
        wprintf(L"%s\n",CkRestW_lastErrorText(rest));
        CkJsonObjectW_Dispose(jsonToken);
        CkRestW_Dispose(rest);
        return;
    }

    sbAuth = CkStringBuilderW_Create();
    CkStringBuilderW_Append(sbAuth,L"Bearer ");
    CkStringBuilderW_Append(sbAuth,CkJsonObjectW_stringOf(jsonToken,L"access_token"));
    CkRestW_putAuthorization(rest,CkStringBuilderW_getAsString(sbAuth));

    CkRestW_AddHeader(rest,L"Accept",L"application/json");
    CkRestW_putAllowHeaderFolding(rest,FALSE);

    query = L"select * from Customer";
    CkRestW_AddQueryParam(rest,L"query",query);
    CkRestW_AddQueryParam(rest,L"minorversion",L"45");

    // The company ID is 123146096291789
    responseBody = CkRestW_fullRequestNoBody(rest,L"GET",L"/v3/company/123146096291789/query");
    if (CkRestW_getLastMethodSuccess(rest) != TRUE) {
        wprintf(L"%s\n",CkRestW_lastErrorText(rest));
        CkJsonObjectW_Dispose(jsonToken);
        CkRestW_Dispose(rest);
        CkStringBuilderW_Dispose(sbAuth);
        return;
    }

    // We should expect a 200 response if successful.
    if (CkRestW_getResponseStatusCode(rest) != 200) {
        wprintf(L"Request Header: \n");
        wprintf(L"%s\n",CkRestW_lastRequestHeader(rest));
        wprintf(L"----\n");
        wprintf(L"Response StatusCode = %d\n",CkRestW_getResponseStatusCode(rest));
        wprintf(L"Response StatusLine: %s\n",CkRestW_responseStatusText(rest));
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkRestW_responseHeader(rest));
        wprintf(L"%s\n",responseBody);
        CkJsonObjectW_Dispose(jsonToken);
        CkRestW_Dispose(rest);
        CkStringBuilderW_Dispose(sbAuth);
        return;
    }

    // Load the JSON response into a JSON object for parsing.
    // A sample JSON response is shown below.
    json = CkJsonObjectW_Create();
    CkJsonObjectW_putEmitCompact(json,FALSE);
    CkJsonObjectW_Load(json,responseBody);

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

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

        CkJsonObjectW_putI(json,i);
        wprintf(L"Name: %s\n",CkJsonObjectW_stringOf(json,L"QueryResponse.Customer[i].FullyQualifiedName"));
        wprintf(L"Id: %s\n",CkJsonObjectW_stringOf(json,L"QueryResponse.Customer[i].Id"));
        wprintf(L"City: %s\n",CkJsonObjectW_stringOf(json,L"QueryResponse.Customer[i].BillAddr.City"));
        wprintf(L"----\n");
        i = i + 1;
    }

    wprintf(L"Success.\n");


    CkJsonObjectW_Dispose(jsonToken);
    CkRestW_Dispose(rest);
    CkStringBuilderW_Dispose(sbAuth);
    CkJsonObjectW_Dispose(json);

    }