Objective-C

QuickBooks - Query Employees

See more QuickBooks Examples

Demonstrates how to query the QuickBooks employee data. Objective-C

#import <CkoJsonObject.h>
#import <CkoRest.h>
#import <CkoStringBuilder.h>
#import <NSString.h>
#import <CkoDateTime.h>
#import <CkoDtObj.h>
#import <CkoStringTable.h>

BOOL success = NO;

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

CkoJsonObject *jsonToken = [[CkoJsonObject alloc] init];
success = [jsonToken LoadFile: @"qa_data/tokens/qb-access-token.json"];

CkoRest *rest = [[CkoRest alloc] init];

// 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.
BOOL bAutoReconnect = YES;
success = [rest Connect: @"sandbox-quickbooks.api.intuit.com" port: [NSNumber numberWithInt: 443] tls: YES autoReconnect: bAutoReconnect];
if (success == NO) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

CkoStringBuilder *sbAuth = [[CkoStringBuilder alloc] init];
[sbAuth Append: @"Bearer "];
[sbAuth Append: [jsonToken StringOf: @"access_token"]];
rest.Authorization = [sbAuth GetAsString];

[rest AddHeader: @"Accept" value: @"application/json"];
rest.AllowHeaderFolding = NO;

NSString *query = @"select * from Employee";
[rest AddQueryParam: @"query" value: query];
[rest AddQueryParam: @"minorversion" value: @"45"];

// The company ID is 123146096291789
NSString *responseBody = [rest FullRequestNoBody: @"GET" uriPath: @"/v3/company/123146096291789/query"];
if (rest.LastMethodSuccess == NO) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

// We should expect a 200 response if successful.
if ([rest.ResponseStatusCode intValue] != 200) {
    NSLog(@"%@",@"Request Header: ");
    NSLog(@"%@",rest.LastRequestHeader);
    NSLog(@"%@",@"----");
    NSLog(@"%@%d",@"Response StatusCode = ",[rest.ResponseStatusCode intValue]);
    NSLog(@"%@%@",@"Response StatusLine: ",rest.ResponseStatusText);
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",rest.ResponseHeader);
    NSLog(@"%@",responseBody);
    return;
}

// Load the JSON response into a JSON object for parsing.
// A sample JSON response is shown below.
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json Load: responseBody];

// Show the full JSON response.
json.EmitCompact = NO;
NSLog(@"%@",[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..
CkoDateTime *dtime = [[CkoDateTime alloc] init];
BOOL bLocalTime = YES;
CkoDtObj *dt = [[CkoDtObj alloc] init];

// Iterate over each account returned.
int numRecords = [[json SizeOfArray: @"QueryResponse.Employee"] intValue];
int i = 0;
while (i < numRecords) {

    json.I = [NSNumber numberWithInt: i];
    NSLog(@"%@%@",@"DisplayName: ",[json StringOf: @"QueryResponse.Employee[i].DisplayName"]);
    NSLog(@"%@%@",@"Id: ",[json StringOf: @"QueryResponse.Employee[i].Id"]);
    NSLog(@"%@%d",@"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 dtObj: dt];

    NSLog(@"%d%@%d%@%d%@%d%@%d",[dt.Month intValue],@"/",[dt.Day intValue],@"/",[dt.Year intValue],@"  ",[dt.Hour intValue]
        ,@":",[dt.Minute intValue]);

    // 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"] == YES) {
        CkoStringTable *sTab = [[CkoStringTable alloc] init];
        [sTab SplitAndAppend: [json StringOf: @"QueryResponse.Employee[i].BirthDate"] delimiterChar: @"-" exceptDoubleQuoted: YES exceptEscaped: YES];
        NSString *year = [sTab StringAt: [NSNumber numberWithInt: 0]];
        NSString *month = [sTab StringAt: [NSNumber numberWithInt: 1]];
        NSString *day = [sTab StringAt: [NSNumber numberWithInt: 2]];
        NSLog(@"%@%@%@%@%@%@",@"BirthDate: ",month,@"/",day,@"/",year);
    }

    NSLog(@"%@",@"----");
    i = i + 1;
}

NSLog(@"%@",@"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"
//