Dart Requires Chilkat v11.0.0+
Dart
QuickBooks - Query Employees
See more QuickBooks Examples
Demonstrates how to query the QuickBooks employee data.Chilkat Dart Downloads
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 Employee';
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.load(responseBody);
// Show the full JSON response.
json.emitCompact = false;
print(json.emit());
// Use this online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON
// These will be used for parsing date/time strings..
final dtime = CkDateTime();
final bLocalTime = true;
final dt = CkDtObj();
// Iterate over each account returned.
final numRecords = json.sizeOfArray('QueryResponse.Employee');
var i = 0;
while (i < numRecords) {
json.i = i;
print('DisplayName: ${json.stringOf('QueryResponse.Employee[i].DisplayName')}');
print('Id: ${json.stringOf('QueryResponse.Employee[i].Id')}');
print('Active: ${json.boolOf('QueryResponse.Employee[i].Active')}');
// Load the CreateTime into a CkDateTime...
dtime.setFromTimestamp(json.stringOf('QueryResponse.Employee[i].MetaData.CreateTime'));
dtime.toDtObj(bLocalTime, dt);
print('${dt.month}/${dt.day}/${dt.year} ${dt.hour}:${dt.minute}');
// The the birth year, month, and day, if it exists.
// The BirthDate contains something like this: "1985-09-11"
if (json.hasMember('QueryResponse.Employee[i].BirthDate')) {
final sTab = CkStringTable();
sTab.splitAndAppend(json.stringOf('QueryResponse.Employee[i].BirthDate'), '-', true, true);
final year = sTab.stringAt(0);
final month = sTab.stringAt(1);
final day = sTab.stringAt(2);
print('BirthDate: $month/$day/$year');
}
print('----');
i++;
}
print('Success.');
// ------------------------------------------------------
// The JSON response looks like this:
// {
// "QueryResponse": {
// "Employee": [
// {
// "BillableTime": false,
// "domain": "QBO",
// "sparse": false,
// "Id": "55",
// "SyncToken": "0",
// "MetaData": {
// "CreateTime": "2016-09-15T11:21:48-07:00",
// "LastUpdatedTime": "2016-09-15T11:21:48-07:00"
// },
// "GivenName": "Emily",
// "FamilyName": "Platt",
// "DisplayName": "Emily Platt",
// "PrintOnCheckName": "Emily Platt",
// "Active": true
// },
// {
// "BillableTime": false,
// "BirthDate": "1985-09-11",
// "HiredDate": "2016-08-17",
// "domain": "QBO",
// "sparse": false,
// "Id": "54",
// "SyncToken": "1",
// "MetaData": {
// "CreateTime": "2016-09-15T11:21:28-07:00",
// "LastUpdatedTime": "2016-09-15T11:46:26-07:00"
// },
// "GivenName": "John",
// "FamilyName": "Johnson",
// "DisplayName": "John Johnson",
// "PrintOnCheckName": "John Johnson",
// "Active": true,
// "PrimaryPhone": {
// "FreeFormNumber": "(540) 555-9645"
// }
// },
// {
// "SSN": "XXX-XX-XXXX",
// "PrimaryAddr": {
// "Id": "98",
// "Line1": "45 N. Elm Street",
// "City": "Middlefield",
// "CountrySubDivisionCode": "CA",
// "PostalCode": "93242"
// },
// "BillableTime": false,
// "domain": "QBO",
// "sparse": false,
// "Id": "60",
// "SyncToken": "0",
// "MetaData": {
// "CreateTime": "2016-10-25T14:08:18-07:00",
// "LastUpdatedTime": "2016-10-25T14:08:18-07:00"
// },
// "GivenName": "John",
// "FamilyName": "Meuller",
// "DisplayName": "John Meuller",
// "PrintOnCheckName": "John Meuller",
// "Active": true,
// "PrimaryPhone": {
// "FreeFormNumber": "408-525-1234"
// }
// }
// ],
// "startPosition": 1,
// "maxResults": 3
// },
// "time": "2016-10-25T14:18:38.487-07:00"
// }
}