(Objective-C) PayPal - Update Invoice

Update a PayPal invoice.

Note: This example requires Chilkat v9.5.0.65 or greater.

Chilkat Objective-C Library Downloads

MAC OS X (Cocoa) Libs

iOS Libs

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

// Note: Requires Chilkat v9.5.0.65 or greater.

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

// Load our previously obtained access token. (see PayPal OAuth2 Access Token)
CkoJsonObject *jsonToken = [[CkoJsonObject alloc] init];
[jsonToken LoadFile: @"qa_data/tokens/paypal.json"];

// Build the Authorization request header field value.
CkoStringBuilder *sbAuth = [[CkoStringBuilder alloc] init];
// token_type should be "Bearer"
[sbAuth Append: [jsonToken StringOf: @"token_type"]];
[sbAuth Append: @" "];
[sbAuth Append: [jsonToken StringOf: @"access_token"]];

// Make the initial connection.
// A single REST object, once connected, can be used for many PayPal 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.
CkoRest *rest = [[CkoRest alloc] init];
BOOL bAutoReconnect = YES;
BOOL success = [rest Connect: @"api.sandbox.paypal.com" port: [NSNumber numberWithInt: 443] tls: YES autoReconnect: bAutoReconnect];
if (success != YES) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

// ----------------------------------------------------------------------------------------------
// The code above this comment could be placed inside a function/subroutine within the application
// because the connection does not need to be made for every request.  Once the connection is made
// the app may send many requests..
// ----------------------------------------------------------------------------------------------

// First create the JSON with updated information:

CkoJsonObject *json = [[CkoJsonObject alloc] init];
json.EmitCompact = NO;
[json UpdateString: @"merchant_info.email" value: @"smith-facilitator@chilkatsoft.com"];
[json UpdateString: @"merchant_info.first_name" value: @"Joe"];
[json UpdateString: @"merchant_info.last_name" value: @"Facilitator"];
[json UpdateString: @"merchant_info.business_name" value: @"Medical Professionals, LLC"];
[json UpdateString: @"merchant_info.phone.country_code" value: @"001"];
[json UpdateString: @"merchant_info.phone.national_number" value: @"5032141716"];
[json UpdateString: @"merchant_info.address.line1" value: @"1234 Main St."];
[json UpdateString: @"merchant_info.address.city" value: @"Portland"];
[json UpdateString: @"merchant_info.address.state" value: @"OR"];
[json UpdateString: @"merchant_info.address.postal_code" value: @"97217"];
[json UpdateString: @"merchant_info.address.country_code" value: @"US"];
[json UpdateString: @"billing_info[0].email" value: @"smith-buyer@chilkatsoft.com"];
[json UpdateString: @"shipping_info.first_name" value: @"Sally"];
[json UpdateString: @"shipping_info.last_name" value: @"Patient"];
[json UpdateString: @"shipping_info.business_name" value: @"Not applicable"];
[json UpdateString: @"shipping_info.phone.country_code" value: @"001"];
[json UpdateString: @"shipping_info.phone.national_number" value: @"5039871234"];
[json UpdateString: @"shipping_info.address.line1" value: @"1234 Broad St."];
[json UpdateString: @"shipping_info.address.city" value: @"Portland"];
[json UpdateString: @"shipping_info.address.state" value: @"OR"];
[json UpdateString: @"shipping_info.address.postal_code" value: @"97216"];
[json UpdateString: @"shipping_info.address.country_code" value: @"US"];
[json UpdateString: @"items[0].name" value: @"Sutures"];
// We are updating the quantity from 100.0 to 200.0
// Note: The UpdateNumber method is added in v9.5.0.65
[json UpdateNumber: @"items[0].quantity" numericStr: @"200.0"];
[json UpdateString: @"items[0].unit_price.currency" value: @"USD"];
[json UpdateString: @"items[0].unit_price.value" value: @"5.00"];
[json UpdateString: @"payment_term.term_type" value: @"NET_45"];
[json UpdateString: @"payment_term.due_date" value: @"2016-12-30 PST"];
[json UpdateString: @"note" value: @"Medical Invoice 16 Jul, 2013 PST"];

// The JSON created by the above code is this:

// 	{ 
// 	  "merchant_info": { 
// 	    "email": "smith-facilitator@chilkatsoft.com",
// 	    "first_name": "Joe",
// 	    "last_name": "Facilitator",
// 	    "business_name": "Medical Professionals, LLC",
// 	    "phone": { 
// 	      "country_code": "001",
// 	      "national_number": "5032141716"
// 	    },
// 	    "address": { 
// 	      "line1": "1234 Main St.",
// 	      "city": "Portland",
// 	      "state": "OR",
// 	      "postal_code": "97217",
// 	      "country_code": "US"
// 	    }
// 	  },
// 	  "billing_info": [
// 	    { 
// 	      "email": "smith-buyer@chilkatsoft.com"
// 	    }
// 	  ],
// 	  "shipping_info": { 
// 	    "first_name": "Sally",
// 	    "last_name": "Patient",
// 	    "business_name": "Not applicable",
// 	    "phone": { 
// 	      "country_code": "001",
// 	      "national_number": "5039871234"
// 	    },
// 	    "address": { 
// 	      "line1": "1234 Broad St.",
// 	      "city": "Portland",
// 	      "state": "OR",
// 	      "postal_code": "97216",
// 	      "country_code": "US"
// 	    }
// 	  },
// 	  "items": [
// 	    { 
// 	      "name": "Sutures",
// 	      "quantity": 200.0,
// 	      "unit_price": { 
// 	        "currency": "USD",
// 	        "value": "5.00"
// 	      }
// 	    }
// 	  ],
// 	  "payment_term": { 
// 	    "term_type": "NET_45",
// 	    "due_date": "2016-12-30 PST"
// 	  },
// 	  "note": "Medical Invoice 16 Jul, 2013 PST"
// 	}

[rest AddHeader: @"Authorization" value: [sbAuth GetAsString]];
[rest AddHeader: @"Content-Type" value: @"application/json"];

NSString *invoiceId = @"INV2-XV4B-736P-PLVN-SZCE";

CkoStringBuilder *sbPath = [[CkoStringBuilder alloc] init];
[sbPath Append: @"/v1/invoicing/invoices/"];
[sbPath Append: invoiceId];

// Send the PUT request containign the JSON in the request body, and get the JSON response.
CkoStringBuilder *sbJsonRequest = [[CkoStringBuilder alloc] init];
[json EmitSb: sbJsonRequest];
CkoStringBuilder *sbJsonResponse = [[CkoStringBuilder alloc] init];
success = [rest FullRequestSb: @"PUT" uriPath: [sbPath GetAsString] requestBody: sbJsonRequest responseBody: sbJsonResponse];
if (success != YES) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

[json LoadSb: sbJsonResponse];

NSLog(@"%@%d",@"Response Status Code = ",[rest.ResponseStatusCode intValue]);

// Did we get a 200 success response?
if ([rest.ResponseStatusCode intValue] != 200) {
    NSLog(@"%@",[json Emit]);
    NSLog(@"%@",@"Failed.");
    return;
}

// Sample response JSON is shown below.

// Get some information..
NSLog(@"%@%@",@"email: ",[json StringOf: @"merchant_info.email"]);
NSLog(@"%@%@",@"business_name: ",[json StringOf: @"merchant_info.business_name"]);

int numItems = [[json SizeOfArray: @"items"] intValue];
int i = 0;
while (i < numItems) {
    json.I = [NSNumber numberWithInt: i];
    NSLog(@"%@%@",@"item name: ",[json StringOf: @"items[i].name"]);
    NSLog(@"%@%@",@"item quantity: ",[json StringOf: @"items[i].quantity"]);
    NSLog(@"%@%@",@"item currency: ",[json StringOf: @"items[i].unit_price.currency"]);
    NSLog(@"%@%@",@"item value: ",[json StringOf: @"items[i].unit_price.value"]);
    NSLog(@"%@",@"----");
    i = i + 1;
}

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