Objective-C

QuickBooks - Read an Employee

See more QuickBooks Examples

Demonstrates how to fetch the information for a specific Quickbooks employee. The employee information is fetched by Id. The employee Ids can be obtained by querying the employees and parsing the JSON that is returned. Objective-C

#import <CkoJsonObject.h>
#import <CkoRest.h>
#import <CkoStringBuilder.h>
#import <NSString.h>
#import <CkoDateTime.h>
#import <CkoDtObj.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;

//  The company ID is 123146096291789
//  The employee ID is 58
NSString *responseBody = [rest FullRequestNoBody: @"GET" uriPath: @"/v3/company/123146096291789/employee/58?minorversion=45"];
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];

//  These will be used for parsing date/time strings..
CkoDateTime *dtime = [[CkoDateTime alloc] init];

//  Show the JSON.   
json.EmitCompact = NO;
NSLog(@"%@",[json Emit]);

//  Get some information from the JSON..
NSLog(@"%@%@",@"Name: ",[json StringOf: @"Employee.DisplayName"]);
NSLog(@"%@%@",@"Id: ",[json StringOf: @"Employee.Id"]);
NSLog(@"%@%@",@"City: ",[json StringOf: @"Employee.PrimaryAddr.City"]);
NSLog(@"%@%@",@"PostalCode: ",[json StringOf: @"Employee.PrimaryAddr.PostalCode"]);

//  Load the CreateTime into a CkDateTime...
[dtime SetFromTimestamp: [json StringOf: @"Employee.MetaData.CreateTime"]];
BOOL bLocalTime = YES;
CkoDtObj *dt = [[CkoDtObj alloc] init];
[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]);

NSLog(@"%@",@"Success.");

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

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

//  {
//    "Employee": {
//      "SSN": "XXX-XX-XXXX",
//      "PrimaryAddr": {
//        "Id": "116",
//        "Line1": "45 N. Elm Street",
//        "City": "Middlefield",
//        "CountrySubDivisionCode": "CA",
//        "PostalCode": "93242"
//      },
//      "BillableTime": false,
//      "domain": "QBO",
//      "sparse": false,
//      "Id": "98",
//      "SyncToken": "0",
//      "MetaData": {
//        "CreateTime": "2015-07-24T09:34:35-07:00",
//        "LastUpdatedTime": "2015-07-24T09:34:35-07:00"
//      },
//      "GivenName": "Bill",
//      "FamilyName": "Miller",
//      "DisplayName": "Bill Miller",
//      "PrintOnCheckName": "Bill Miller",
//      "Active": true,
//      "PrimaryPhone": {
//        "FreeFormNumber": "234-525-1234"
//      }
//    },
//    "time": "2015-07-24T09:35:54.805-07:00"
//  }