Objective-C
Objective-C
QuickBooks - Query an Account
See more QuickBooks Examples
Demonstrates how to query the QuickBooks chart of accounts.Chilkat Objective-C Downloads
#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;
// Add a SELECT statement
[rest AddQueryParam: @"query" value: @"select * from Account where Metadata.CreateTime > '2014-12-31'"];
[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;
}
[rest ClearAllQueryParams];
// 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;
}
// Use this online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON
// 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];
BOOL bLocalTime = YES;
CkoDtObj *dt = [[CkoDtObj alloc] init];
// Iterate over each account returned.
int numAccounts = [[json SizeOfArray: @"QueryResponse.Account"] intValue];
int i = 0;
while (i < numAccounts) {
json.I = [NSNumber numberWithInt: i];
NSLog(@"%@%@",@"Name: ",[json StringOf: @"QueryResponse.Account[i].Name"]);
NSLog(@"%@%@",@"Id: ",[json StringOf: @"QueryResponse.Account[i].Id"]);
// Load the CreateTime into a CkDateTime...
[dtime SetFromTimestamp: [json StringOf: @"QueryResponse.Account[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]);
NSLog(@"%@",@"----");
i = i + 1;
}
NSLog(@"%@",@"Success.");
// ------------------------------------------------------
// The JSON response looks like this:
// {
// "QueryResponse": {
// "Account": [
// {
// "Name": "Accounts Payable (A/P)",
// "SubAccount": false,
// "FullyQualifiedName": "Accounts Payable (A/P)",
// "Active": true,
// "Classification": "Liability",
// "AccountType": "Accounts Payable",
// "AccountSubType": "AccountsPayable",
// "CurrentBalance": -1602.67,
// "CurrentBalanceWithSubAccounts": -1602.67,
// "CurrencyRef": {
// "value": "USD",
// "name": "United States Dollar"
// },
// "domain": "QBO",
// "sparse": false,
// "Id": "33",
// "SyncToken": "0",
// "MetaData": {
// "CreateTime": "2016-09-10T10:12:02-07:00",
// "LastUpdatedTime": "2016-09-17T13:10:36-07:00"
// }
// },
// {
// "Name": "Accounts Receivable (A/R)",
// "SubAccount": false,
// "FullyQualifiedName": "Accounts Receivable (A/R)",
// "Active": true,
// "Classification": "Asset",
// "AccountType": "Accounts Receivable",
// "AccountSubType": "AccountsReceivable",
// "CurrentBalance": 5281.52,
// "CurrentBalanceWithSubAccounts": 5281.52,
// "CurrencyRef": {
// "value": "USD",
// "name": "United States Dollar"
// },
// "domain": "QBO",
// "sparse": false,
// "Id": "84",
// "SyncToken": "0",
// "MetaData": {
// "CreateTime": "2016-09-14T14:49:29-07:00",
// "LastUpdatedTime": "2016-09-17T13:16:17-07:00"
// }
// },
// {
// "Name": "Advertising",
// "SubAccount": false,
// "FullyQualifiedName": "Advertising",
// "Active": true,
// "Classification": "Expense",
// "AccountType": "Expense",
// "AccountSubType": "AdvertisingPromotional",
// "CurrentBalance": 0,
// "CurrentBalanceWithSubAccounts": 0,
// "CurrencyRef": {
// "value": "USD",
// "name": "United States Dollar"
// },
// "domain": "QBO",
// "sparse": false,
// "Id": "7",
// "SyncToken": "0",
// "MetaData": {
// "CreateTime": "2016-09-09T14:42:07-07:00",
// "LastUpdatedTime": "2016-09-09T14:42:07-07:00"
// }
// },
// ...
// "time": "2016-10-24T15:35:25.067-07:00"
//