(Objective-C) Quickbooks Update an Invoice

Demonstrates how to update an invoice using the Quickbooks REST API.

For more information, see https://www.developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/invoice#full-update-an-invoice

Chilkat Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoJsonObject.h>
#import <CkoRest.h>
#import <CkoStringBuilder.h>
#import <NSString.h>

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// First get our previously obtained OAuth2 access token.
CkoJsonObject *jsonToken = [[CkoJsonObject alloc] init];
BOOL success = [jsonToken LoadFile: @"qa_data/tokens/qb-access-token.json"];

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

// Connect to the REST server.
BOOL bTls = YES;
int port = 443;
BOOL bAutoReconnect = YES;
BOOL success = [rest Connect: @"sandbox-quickbooks.api.intuit.com" port: [NSNumber numberWithInt: port] tls: bTls autoReconnect: bAutoReconnect];

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

// --------------------------------------------------------------------------
// Note: The above code to setup the initial REST connection
// can be done once.  After connecting, any number of REST calls can be made.
// If the connection is lost, the next REST method call will automatically
// reconnect if needed.
// --------------------------------------------------------------------------

// Create the following JSON:

// {
//   "DocNumber": "1070",
//   "SyncToken": "0",
//   "domain": "QBO",
//   "Balance": 150.0,
//   "BillAddr": {
//     "City": "Bayshore",
//     "Line1": "4581 Finch St.",
//     "PostalCode": "94326",
//     "Lat": "INVALID",
//     "Long": "INVALID",
//     "CountrySubDivisionCode": "CA",
//     "Id": "2"
//   },
//   "TxnDate": "2015-07-24",
//   "TotalAmt": 150.0,
//   "CustomerRef": {
//     "name": "Amy's Bird Sanctuary",
//     "value": "1"
//   },
//   "CustomerMemo": {
//     "value": "Added customer memo."
//   },
//   "ShipAddr": {
//     "City": "Bayshore",
//     "Line1": "4581 Finch St.",
//     "PostalCode": "94326",
//     "Lat": "INVALID",
//     "Long": "INVALID",
//     "CountrySubDivisionCode": "CA",
//     "Id": "109"
//   },
//   "LinkedTxn": [
//   ],
//   "DueDate": "2015-08-23",
//   "PrintStatus": "NeedToPrint",
//   "EmailStatus": "NotSet",
//   "sparse": false,
//   "Line": [
//     {
//       "LineNum": 1,
//       "Amount": 150.0,
//       "SalesItemLineDetail": {
//         "TaxCodeRef": {
//           "value": "NON"
//         },
//         "ItemRef": {
//           "name": "Services",
//           "value": "1"
//         }
//       },
//       "Id": "1",
//       "DetailType": "SalesItemLineDetail"
//     },
//     {
//       "DetailType": "SubTotalLineDetail",
//       "Amount": 150.0,
//       "SubTotalLineDetail": {}
//     }
//   ],
//   "ApplyTaxAfterDiscount": false,
//   "CustomField": [
//     {
//       "DefinitionId": "1",
//       "Type": "StringType",
//       "Name": "Crew #"
//     }
//   ],
//   "Id": "239",
//   "TxnTaxDetail": {
//     "TotalTax": 0
//   },
//   "MetaData": {
//     "CreateTime": "2015-07-24T10:35:08-07:00",
//     "LastUpdatedTime": "2015-07-24T10:35:08-07:00"
//   }
// }
// 
// Use the this online tool to generate the code from sample JSON: 
// Generate Code to Create JSON

CkoJsonObject *jsonReq = [[CkoJsonObject alloc] init];
[jsonReq UpdateString: @"DocNumber" value: @"1070"];
[jsonReq UpdateString: @"SyncToken" value: @"0"];
[jsonReq UpdateString: @"domain" value: @"QBO"];
[jsonReq UpdateNumber: @"Balance" numericStr: @"150.0"];
[jsonReq UpdateString: @"BillAddr.City" value: @"Bayshore"];
[jsonReq UpdateString: @"BillAddr.Line1" value: @"4581 Finch St."];
[jsonReq UpdateString: @"BillAddr.PostalCode" value: @"94326"];
[jsonReq UpdateString: @"BillAddr.Lat" value: @"INVALID"];
[jsonReq UpdateString: @"BillAddr.Long" value: @"INVALID"];
[jsonReq UpdateString: @"BillAddr.CountrySubDivisionCode" value: @"CA"];
[jsonReq UpdateString: @"BillAddr.Id" value: @"2"];
[jsonReq UpdateString: @"TxnDate" value: @"2015-07-24"];
[jsonReq UpdateNumber: @"TotalAmt" numericStr: @"150.0"];
[jsonReq UpdateString: @"CustomerRef.name" value: @"Amy's Bird Sanctuary"];
[jsonReq UpdateString: @"CustomerRef.value" value: @"1"];
[jsonReq UpdateString: @"CustomerMemo.value" value: @"Added customer memo."];
[jsonReq UpdateString: @"ShipAddr.City" value: @"Bayshore"];
[jsonReq UpdateString: @"ShipAddr.Line1" value: @"4581 Finch St."];
[jsonReq UpdateString: @"ShipAddr.PostalCode" value: @"94326"];
[jsonReq UpdateString: @"ShipAddr.Lat" value: @"INVALID"];
[jsonReq UpdateString: @"ShipAddr.Long" value: @"INVALID"];
[jsonReq UpdateString: @"ShipAddr.CountrySubDivisionCode" value: @"CA"];
[jsonReq UpdateString: @"ShipAddr.Id" value: @"109"];
[jsonReq UpdateNewArray: @"LinkedTxn"];
[jsonReq UpdateString: @"DueDate" value: @"2015-08-23"];
[jsonReq UpdateString: @"PrintStatus" value: @"NeedToPrint"];
[jsonReq UpdateString: @"EmailStatus" value: @"NotSet"];
[jsonReq UpdateBool: @"sparse" value: NO];
[jsonReq UpdateInt: @"Line[0].LineNum" value: [NSNumber numberWithInt: 1]];
[jsonReq UpdateNumber: @"Line[0].Amount" numericStr: @"150.0"];
[jsonReq UpdateString: @"Line[0].SalesItemLineDetail.TaxCodeRef.value" value: @"NON"];
[jsonReq UpdateString: @"Line[0].SalesItemLineDetail.ItemRef.name" value: @"Services"];
[jsonReq UpdateString: @"Line[0].SalesItemLineDetail.ItemRef.value" value: @"1"];
[jsonReq UpdateString: @"Line[0].Id" value: @"1"];
[jsonReq UpdateString: @"Line[0].DetailType" value: @"SalesItemLineDetail"];
[jsonReq UpdateString: @"Line[1].DetailType" value: @"SubTotalLineDetail"];
[jsonReq UpdateNumber: @"Line[1].Amount" numericStr: @"150.0"];
[jsonReq UpdateNewObject: @"Line[1].SubTotalLineDetail"];
[jsonReq UpdateBool: @"ApplyTaxAfterDiscount" value: NO];
[jsonReq UpdateString: @"CustomField[0].DefinitionId" value: @"1"];
[jsonReq UpdateString: @"CustomField[0].Type" value: @"StringType"];
[jsonReq UpdateString: @"CustomField[0].Name" value: @"Crew #"];
[jsonReq UpdateString: @"Id" value: @"239"];
[jsonReq UpdateInt: @"TxnTaxDetail.TotalTax" value: [NSNumber numberWithInt: 0]];
[jsonReq UpdateString: @"MetaData.CreateTime" value: @"2015-07-24T10:35:08-07:00"];
[jsonReq UpdateString: @"MetaData.LastUpdatedTime" value: @"2015-07-24T10:35:08-07:00"];

CkoStringBuilder *sbRequestBody = [[CkoStringBuilder alloc] init];
[jsonReq EmitSb: sbRequestBody];

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

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [rest FullRequestSb: @"POST" uriPath: @"/v3/company/<realmID>/invoice" requestBody: sbRequestBody responseBody: sbResponseBody];
if (success != YES) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

int respStatusCode = [rest.ResponseStatusCode intValue];

// Success is indicated by a 200 response status code.
NSLog(@"%@%d",@"response status code = ",respStatusCode);

CkoJsonObject *jsonResponse = [[CkoJsonObject alloc] init];
[jsonResponse LoadSb: sbResponseBody];
jsonResponse.EmitCompact = NO;
NSLog(@"%@",[jsonResponse Emit]);

if ([rest.ResponseStatusCode intValue] != 200) {
    NSLog(@"%@",@"Failed.");
    return;
}

// Sample output...
// (See the parsing code below..)
// 
// Use the this online tool to generate parsing code from sample JSON: 
// Generate Parsing Code from JSON

// {
//   "Invoice": {
//     "TxnDate": "2015-07-24",
//     "domain": "QBO",
//     "PrintStatus": "NeedToPrint",
//     "TotalAmt": 150.0,
//     "Line": [
//       {
//         "LineNum": 1,
//         "Amount": 150.0,
//         "SalesItemLineDetail": {
//           "TaxCodeRef": {
//             "value": "NON"
//           },
//           "ItemRef": {
//             "name": "Services",
//             "value": "1"
//           }
//         },
//         "Id": "1",
//         "DetailType": "SalesItemLineDetail"
//       },
//       {
//         "DetailType": "SubTotalLineDetail",
//         "Amount": 150.0,
//         "SubTotalLineDetail": {}
//       }
//     ],
//     "DueDate": "2015-08-23",
//     "ApplyTaxAfterDiscount": false,
//     "DocNumber": "1070",
//     "sparse": false,
//     "CustomerMemo": {
//       "value": "Added customer memo."
//     },
//     "Deposit": 0,
//     "Balance": 150.0,
//     "CustomerRef": {
//       "name": "Amy's Bird Sanctuary",
//       "value": "1"
//     },
//     "TxnTaxDetail": {
//       "TotalTax": 0
//     },
//     "SyncToken": "1",
//     "LinkedTxn": [
//     ],
//     "ShipAddr": {
//       "CountrySubDivisionCode": "CA",
//       "City": "Bayshore",
//       "PostalCode": "94326",
//       "Id": "118",
//       "Line1": "4581 Finch St."
//     },
//     "EmailStatus": "NotSet",
//     "BillAddr": {
//       "CountrySubDivisionCode": "CA",
//       "City": "Bayshore",
//       "PostalCode": "94326",
//       "Id": "117",
//       "Line1": "4581 Finch St."
//     },
//     "MetaData": {
//       "CreateTime": "2015-07-24T10:35:08-07:00",
//       "LastUpdatedTime": "2015-07-24T10:53:39-07:00"
//     },
//     "CustomField": [
//       {
//         "DefinitionId": "1",
//         "Type": "StringType",
//         "Name": "Crew #"
//       }
//     ],
//     "Id": "239"
//   },
//   "time": "2015-07-24T10:53:39.287-07:00"
// }
// 

int LineNum;
NSString *Amount = 0;
NSString *SalesItemLineDetailTaxCodeRefValue = 0;
NSString *SalesItemLineDetailItemRefName = 0;
NSString *SalesItemLineDetailItemRefValue = 0;
NSString *Id = 0;
NSString *DetailType = 0;
NSString *DefinitionId = 0;
NSString *invType = 0;
NSString *Name = 0;

NSString *InvoiceTxnDate = [jsonResponse StringOf: @"Invoice.TxnDate"];
NSString *InvoiceDomain = [jsonResponse StringOf: @"Invoice.domain"];
NSString *InvoicePrintStatus = [jsonResponse StringOf: @"Invoice.PrintStatus"];
NSString *InvoiceTotalAmt = [jsonResponse StringOf: @"Invoice.TotalAmt"];
NSString *InvoiceDueDate = [jsonResponse StringOf: @"Invoice.DueDate"];
BOOL InvoiceApplyTaxAfterDiscount = [jsonResponse BoolOf: @"Invoice.ApplyTaxAfterDiscount"];
NSString *InvoiceDocNumber = [jsonResponse StringOf: @"Invoice.DocNumber"];
BOOL InvoiceSparse = [jsonResponse BoolOf: @"Invoice.sparse"];
NSString *InvoiceCustomerMemoValue = [jsonResponse StringOf: @"Invoice.CustomerMemo.value"];
int InvoiceDeposit = [[jsonResponse IntOf: @"Invoice.Deposit"] intValue];
NSString *InvoiceBalance = [jsonResponse StringOf: @"Invoice.Balance"];
NSString *InvoiceCustomerRefName = [jsonResponse StringOf: @"Invoice.CustomerRef.name"];
NSString *InvoiceCustomerRefValue = [jsonResponse StringOf: @"Invoice.CustomerRef.value"];
int InvoiceTxnTaxDetailTotalTax = [[jsonResponse IntOf: @"Invoice.TxnTaxDetail.TotalTax"] intValue];
NSString *InvoiceSyncToken = [jsonResponse StringOf: @"Invoice.SyncToken"];
NSString *InvoiceShipAddrCountrySubDivisionCode = [jsonResponse StringOf: @"Invoice.ShipAddr.CountrySubDivisionCode"];
NSString *InvoiceShipAddrCity = [jsonResponse StringOf: @"Invoice.ShipAddr.City"];
NSString *InvoiceShipAddrPostalCode = [jsonResponse StringOf: @"Invoice.ShipAddr.PostalCode"];
NSString *InvoiceShipAddrId = [jsonResponse StringOf: @"Invoice.ShipAddr.Id"];
NSString *InvoiceShipAddrLine1 = [jsonResponse StringOf: @"Invoice.ShipAddr.Line1"];
NSString *InvoiceEmailStatus = [jsonResponse StringOf: @"Invoice.EmailStatus"];
NSString *InvoiceBillAddrCountrySubDivisionCode = [jsonResponse StringOf: @"Invoice.BillAddr.CountrySubDivisionCode"];
NSString *InvoiceBillAddrCity = [jsonResponse StringOf: @"Invoice.BillAddr.City"];
NSString *InvoiceBillAddrPostalCode = [jsonResponse StringOf: @"Invoice.BillAddr.PostalCode"];
NSString *InvoiceBillAddrId = [jsonResponse StringOf: @"Invoice.BillAddr.Id"];
NSString *InvoiceBillAddrLine1 = [jsonResponse StringOf: @"Invoice.BillAddr.Line1"];
NSString *InvoiceMetaDataCreateTime = [jsonResponse StringOf: @"Invoice.MetaData.CreateTime"];
NSString *InvoiceMetaDataLastUpdatedTime = [jsonResponse StringOf: @"Invoice.MetaData.LastUpdatedTime"];
NSString *InvoiceId = [jsonResponse StringOf: @"Invoice.Id"];
NSString *time = [jsonResponse StringOf: @"time"];
int i = 0;
int count_i = [[jsonResponse SizeOfArray: @"Invoice.Line"] intValue];
while (i < count_i) {
    jsonResponse.I = [NSNumber numberWithInt: i];
    LineNum = [[jsonResponse IntOf: @"Invoice.Line[i].LineNum"] intValue];
    Amount = [jsonResponse StringOf: @"Invoice.Line[i].Amount"];
    SalesItemLineDetailTaxCodeRefValue = [jsonResponse StringOf: @"Invoice.Line[i].SalesItemLineDetail.TaxCodeRef.value"];
    SalesItemLineDetailItemRefName = [jsonResponse StringOf: @"Invoice.Line[i].SalesItemLineDetail.ItemRef.name"];
    SalesItemLineDetailItemRefValue = [jsonResponse StringOf: @"Invoice.Line[i].SalesItemLineDetail.ItemRef.value"];
    Id = [jsonResponse StringOf: @"Invoice.Line[i].Id"];
    DetailType = [jsonResponse StringOf: @"Invoice.Line[i].DetailType"];
    i = i + 1;
}

i = 0;
count_i = [[jsonResponse SizeOfArray: @"Invoice.LinkedTxn"] intValue];
while (i < count_i) {
    jsonResponse.I = [NSNumber numberWithInt: i];
    i = i + 1;
}

i = 0;
count_i = [[jsonResponse SizeOfArray: @"Invoice.CustomField"] intValue];
while (i < count_i) {
    jsonResponse.I = [NSNumber numberWithInt: i];
    DefinitionId = [jsonResponse StringOf: @"Invoice.CustomField[i].DefinitionId"];
    invType = [jsonResponse StringOf: @"Invoice.CustomField[i].Type"];
    Name = [jsonResponse StringOf: @"Invoice.CustomField[i].Name"];
    i = i + 1;
}