Node.js

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

Node.js

NODEJS_PRELUDE

function chilkatExample() {

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

    var jsonToken = new chilkat.JsonObject();
    success = jsonToken.LoadFile("qa_data/tokens/qb-access-token.json");

    var rest = new chilkat.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.
    var bAutoReconnect = true;
    success = rest.Connect("sandbox-quickbooks.api.intuit.com",443,true,bAutoReconnect);
    if (success !== true) {
        console.log(rest.LastErrorText);
        return;
    }

    var sbAuth = new chilkat.StringBuilder();
    sbAuth.Append("Bearer ");
    sbAuth.Append(jsonToken.StringOf("access_token"));
    rest.Authorization = sbAuth.GetAsString();

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

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

    // The company ID is 123146096291789
    var responseBody = rest.FullRequestNoBody("GET","/v3/company/123146096291789/query");
    if (rest.LastMethodSuccess !== true) {
        console.log(rest.LastErrorText);
        return;
    }

    // We should expect a 200 response if successful.
    if (rest.ResponseStatusCode !== 200) {
        console.log("Request Header: ");
        console.log(rest.LastRequestHeader);
        console.log("----");
        console.log("Response StatusCode = " + rest.ResponseStatusCode);
        console.log("Response StatusLine: " + rest.ResponseStatusText);
        console.log("Response Header:");
        console.log(rest.ResponseHeader);
        console.log(responseBody);
        return;
    }

    // Load the JSON response into a JSON object for parsing.
    // A sample JSON response is shown below.
    var json = new chilkat.JsonObject();
    json.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.
    var numRecords = json.SizeOfArray("QueryResponse.Customer");
    var i = 0;
    while (i < numRecords) {

        json.I = i;
        console.log("Name: " + json.StringOf("QueryResponse.Customer[i].FullyQualifiedName"));
        console.log("Id: " + json.StringOf("QueryResponse.Customer[i].Id"));
        console.log("City: " + json.StringOf("QueryResponse.Customer[i].BillAddr.City"));
        console.log("----");
        i = i+1;
    }

    console.log("Success.");

}

chilkatExample();