(Objective-C) PayPal - Show Invoice Details

Shows details for a PayPal invoice, by ID.

See also PayPal Show Invoice Details REST API Reference

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.64 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..
// ----------------------------------------------------------------------------------------------

[rest AddHeader: @"Authorization" value: [sbAuth GetAsString]];

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

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

// Send the GET request and get the JSON response.
CkoStringBuilder *sbJsonResponse = [[CkoStringBuilder alloc] init];
success = [rest FullRequestNoBodySb: @"GET" uriPath: [sbPath GetAsString] sb: sbJsonResponse];
if (success != YES) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

CkoJsonObject *json = [[CkoJsonObject alloc] init];
json.EmitCompact = NO;
[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.");

// ---------------------------------------------------
// A sample response:

// 	{
// 	  "id": "INV2-XV4B-736P-PLVN-SZCE",
// 	  "number": "0002",
// 	  "template_id": "TEMP-8HS37702UW384535K",
// 	  "status": "DRAFT",
// 	  "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": 100.0,
// 	      "unit_price": {
// 	        "currency": "USD",
// 	        "value": "5.00"
// 	      }
// 	    }
// 	  ],
// 	  "invoice_date": "2016-11-15 PST",
// 	  "payment_term": {
// 	    "term_type": "NET_45",
// 	    "due_date": "2016-12-30 PST"
// 	  },
// 	  "tax_calculated_after_discount": false,
// 	  "tax_inclusive": false,
// 	  "note": "Medical Invoice 16 Jul, 2013 PST",
// 	  "total_amount": {
// 	    "currency": "USD",
// 	    "value": "500.00"
// 	  },
// 	  "metadata": {
// 	    "created_date": "2016-11-15 08:09:21 PST"
// 	  },
// 	  "links": [
// 	    {
// 	      "rel": "self",
// 	      "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE",
// 	      "method": "GET"
// 	    },
// 	    {
// 	      "rel": "send",
// 	      "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE/send",
// 	      "method": "POST"
// 	    },
// 	    {
// 	      "rel": "update",
// 	      "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE/update",
// 	      "method": "PUT"
// 	    },
// 	    {
// 	      "rel": "delete",
// 	      "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE",
// 	      "method": "DELETE"
// 	    }
// 	  ]
// 	}
//