Objective-C

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

Objective-C

#import <CkoJsonObject.h>
#import <CkoRest.h>
#import <CkoStringBuilder.h>
#import <NSString.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 != YES) {
    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 Customer";
[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 != YES) {
    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.EmitCompact = NO;
[json Load: responseBody];

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

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

    json.I = [NSNumber numberWithInt: i];
    NSLog(@"%@%@",@"Name: ",[json StringOf: @"QueryResponse.Customer[i].FullyQualifiedName"]);
    NSLog(@"%@%@",@"Id: ",[json StringOf: @"QueryResponse.Customer[i].Id"]);
    NSLog(@"%@%@",@"City: ",[json StringOf: @"QueryResponse.Customer[i].BillAddr.City"]);
    NSLog(@"%@",@"----");
    i = i + 1;
}

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