Dart

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

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;

  final query = 'select * from Customer';
  rest.addQueryParam('query', query);
  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;
  }

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

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

    json.i = i;
    print('Name: ${json.stringOf('QueryResponse.Customer[i].FullyQualifiedName')}');
    print('Id: ${json.stringOf('QueryResponse.Customer[i].Id')}');
    print('City: ${json.stringOf('QueryResponse.Customer[i].BillAddr.City')}');
    print('----');
    i++;
  }

  print('Success.');
}