Dart Requires Chilkat v11.0.0+

QuickBooks - Query an Account

See more QuickBooks Examples

Demonstrates how to query the QuickBooks chart of accounts. Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // 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"
  // }

  final jsonToken = CkJsonObject();
  jsonToken.loadFile('qa_data/tokens/qb-access-token.json');

  final rest = CkRest();

  // 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.
  final bAutoReconnect = true;
  try {
    rest.connect('sandbox-quickbooks.api.intuit.com', 443, true, bAutoReconnect);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  final sbAuth = CkStringBuilder();
  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
  final String responseBody;
  try {
    responseBody = rest.fullRequestNoBody('GET', '/v3/company/123146096291789/query');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  rest.clearAllQueryParams();

  // We should expect a 200 response if successful.
  if (rest.responseStatusCode != 200) {
    print('Request Header: ');
    print(rest.lastRequestHeader);
    print('----');
    print('Response StatusCode = ${rest.responseStatusCode}');
    print('Response StatusLine: ${rest.responseStatusText}');
    print('Response Header:');
    print(rest.responseHeader);
    print(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.
  final json = CkJsonObject();
  json.load(responseBody);

  // These will be used for parsing date/time strings..
  final dtime = CkDateTime();
  final bLocalTime = true;
  final dt = CkDtObj();

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

    json.i = i;
    print('Name: ${json.stringOf('QueryResponse.Account[i].Name')}');
    print('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);

    print('${dt.month}/${dt.day}/${dt.year}  ${dt.hour}:${dt.minute}');

    print('----');
    i++;
  }

  print('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"
  // }
}