Node.js

QuickBooks - Query an Account

See more QuickBooks Examples

Demonstrates how to query the QuickBooks chart of accounts. 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 == false) {
        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;

    //  Add a SELECT statement 
    rest.AddQueryParam("query","select * from Account where Metadata.CreateTime > '2014-12-31'");
    rest.AddQueryParam("minorversion","45");

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

    rest.ClearAllQueryParams();

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

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

    //  Load the JSON response into a JSON object for parsing.
    //  A sample JSON response is shown below.
    var json = new chilkat.JsonObject();
    json.Load(responseBody);

    //  These will be used for parsing date/time strings..
    var dtime = new chilkat.CkDateTime();
    var bLocalTime = true;
    var dt = new chilkat.DtObj();

    //  Iterate over each account returned.
    var numAccounts = json.SizeOfArray("QueryResponse.Account");
    var i = 0;
    while (i < numAccounts) {

        json.I = i;
        console.log("Name: " + json.StringOf("QueryResponse.Account[i].Name"));
        console.log("Id: " + json.StringOf("QueryResponse.Account[i].Id"));

        //  Load the CreateTime into a CkDateTime...
        dtime.SetFromTimestamp(json.StringOf("QueryResponse.Account[i].MetaData.CreateTime"));
        dtime.ToDtObj(bLocalTime,dt);

        console.log(dt.Month + "/" + dt.Day + "/" + dt.Year + "  " + dt.Hour + ":" + dt.Minute);

        console.log("----");
        i = i+1;
    }

    console.log("Success.");

    //  ------------------------------------------------------
    //  The JSON response looks like this:

    //  {
    //    "QueryResponse": {
    //      "Account": [
    //        {
    //          "Name": "Accounts Payable (A/P)",
    //          "SubAccount": false,
    //          "FullyQualifiedName": "Accounts Payable (A/P)",
    //          "Active": true,
    //          "Classification": "Liability",
    //          "AccountType": "Accounts Payable",
    //          "AccountSubType": "AccountsPayable",
    //          "CurrentBalance": -1602.67,
    //          "CurrentBalanceWithSubAccounts": -1602.67,
    //          "CurrencyRef": {
    //            "value": "USD",
    //            "name": "United States Dollar"
    //          },
    //          "domain": "QBO",
    //          "sparse": false,
    //          "Id": "33",
    //          "SyncToken": "0",
    //          "MetaData": {
    //            "CreateTime": "2016-09-10T10:12:02-07:00",
    //            "LastUpdatedTime": "2016-09-17T13:10:36-07:00"
    //          }
    //        },
    //        {
    //          "Name": "Accounts Receivable (A/R)",
    //          "SubAccount": false,
    //          "FullyQualifiedName": "Accounts Receivable (A/R)",
    //          "Active": true,
    //          "Classification": "Asset",
    //          "AccountType": "Accounts Receivable",
    //          "AccountSubType": "AccountsReceivable",
    //          "CurrentBalance": 5281.52,
    //          "CurrentBalanceWithSubAccounts": 5281.52,
    //          "CurrencyRef": {
    //            "value": "USD",
    //            "name": "United States Dollar"
    //          },
    //          "domain": "QBO",
    //          "sparse": false,
    //          "Id": "84",
    //          "SyncToken": "0",
    //          "MetaData": {
    //            "CreateTime": "2016-09-14T14:49:29-07:00",
    //            "LastUpdatedTime": "2016-09-17T13:16:17-07:00"
    //          }
    //        },
    //        {
    //          "Name": "Advertising",
    //          "SubAccount": false,
    //          "FullyQualifiedName": "Advertising",
    //          "Active": true,
    //          "Classification": "Expense",
    //          "AccountType": "Expense",
    //          "AccountSubType": "AdvertisingPromotional",
    //          "CurrentBalance": 0,
    //          "CurrentBalanceWithSubAccounts": 0,
    //          "CurrencyRef": {
    //            "value": "USD",
    //            "name": "United States Dollar"
    //          },
    //          "domain": "QBO",
    //          "sparse": false,
    //          "Id": "7",
    //          "SyncToken": "0",
    //          "MetaData": {
    //            "CreateTime": "2016-09-09T14:42:07-07:00",
    //            "LastUpdatedTime": "2016-09-09T14:42:07-07:00"
    //          }
    //        },
    //  ...
    //    "time": "2016-10-24T15:35:25.067-07:00"
    //  }

}

chilkatExample();