(Objective-C) PayPal Search for Invoices

Search PayPal invoices.

See also SearchInvoices

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

#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <CkoRest.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..
// ----------------------------------------------------------------------------------------------

// Create JSON to specify the search
CkoJsonObject *json = [[CkoJsonObject alloc] init];
json.EmitCompact = NO;
[json AppendString: @"start_invoice_date" value: @"2016-01-01 PST"];
[json AppendString: @"end_invoice_date" value: @"2016-11-16 PST"];
[json AppendInt: @"page" value: [NSNumber numberWithInt: 0]];
[json AppendInt: @"page_size" value: [NSNumber numberWithInt: 10]];
[json AppendBool: @"total_count_required" value: YES];

NSLog(@"%@",[json Emit]);

// The JSON by the above code:

// 	{
// 	  "start_invoice_date": "2016-01-01 PST",
// 	  "end_invoice_date": "2016-11-16 PST",
// 	  "page": 0,
// 	  "page_size": 10,
// 	  "total_count_required": true
// 	}

// Send the POST equivalent to this CURL command:

// 	curl -v -X POST https://api.sandbox.paypal.com/v1/invoicing/search/ \
// 	-H "Content-Type:application/json" \
// 	-H "Authorization: Bearer Access-Token" \
// 	-d '{ invoice JSON goes here }'

json.EmitCompact = YES;
CkoStringBuilder *sbRequestBody = [[CkoStringBuilder alloc] init];
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];

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

success = [rest FullRequestSb: @"POST" uriPath: @"/v1/invoicing/search" requestBody: sbRequestBody responseBody: sbResponseBody];
if (success != YES) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

// We should have some sort of JSON response.  It could be successful, or an error.
CkoJsonObject *jsonResponse = [[CkoJsonObject alloc] init];
jsonResponse.EmitCompact = NO;
[jsonResponse LoadSb: sbResponseBody];

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

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

// Sample response JSON is shown below.

// Iterate over each invoice and get some information from each..
int numInvoices = [[jsonResponse SizeOfArray: @"invoices"] intValue];
int i = 0;
while (i < numInvoices) {
    jsonResponse.I = [NSNumber numberWithInt: i];
    NSLog(@"%@%@",@"Invoice ID: ",[jsonResponse StringOf: @"invoices[i].id"]);
    NSLog(@"%@%@",@"Shipping First Name: ",[jsonResponse StringOf: @"invoices[i].shipping_info.first_name"]);
    int j = 0;
    int numBillingInfo = [[jsonResponse SizeOfArray: @"invoices[i].billing_info"] intValue];
    while (j < numBillingInfo) {
        jsonResponse.J = [NSNumber numberWithInt: j];
        NSLog(@"%@%@",@"billing_info email: ",[jsonResponse StringOf: @"invoices[i].billing_info[j].email"]);
        j = j + 1;
    }

    int numLinks = [[jsonResponse SizeOfArray: @"invoices[i].links"] intValue];
    j = 0;
    while (j < numLinks) {
        jsonResponse.J = [NSNumber numberWithInt: j];
        NSLog(@"%@%@",@"link: ",[jsonResponse StringOf: @"invoices[i].links[j].href"]);
        j = j + 1;
    }

    NSLog(@"%@",@"----");
    i = i + 1;
}

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

// A successful response looks like this:

// { 
//   "total_count": 2,
//   "invoices": [
//     { 
//       "id": "INV2-XV4B-736P-PLVN-SZCE",
//       "number": "0002",
//       "status": "DRAFT",
//       "merchant_info": { 
//         "email": "smith-facilitator@chilkatsoft.com"
//       },
//       "billing_info": [
//         { 
//           "email": "smith-buyer@chilkatsoft.com"
//         }
//       ],
//       "shipping_info": { 
//         "email": "smith-buyer@chilkatsoft.com",
//         "first_name": "Sally",
//         "last_name": "Patient",
//         "business_name": "Not applicable"
//       },
//       "invoice_date": "2016-11-15 PST",
//       "payment_term": { 
//         "due_date": "2016-12-30 PST"
//       },
//       "note": "Medical Invoice 16 Jul, 2013 PST",
//       "total_amount": { 
//         "currency": "USD",
//         "value": "500.00"
//       },
//       "metadata": { 
//         "created_date": "2016-11-15 08:09:21 PST"
//       },
//       "paid_amount": { 
//         "paypal": { 
//           "currency": "USD",
//           "value": "0.00"
//         },
//         "other": { 
//           "currency": "USD",
//           "value": "0.00"
//         }
//       },
//       "refunded_amount": { 
//         "paypal": { 
//           "currency": "USD",
//           "value": "0.00"
//         },
//         "other": { 
//           "currency": "USD",
//           "value": "0.00"
//         }
//       },
//       "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"
//         }
//       ]
//     },
//     { 
//       "id": "INV2-ZG2H-HKAW-PMWU-N6ZR",
//       "number": "0001",
//       "status": "SENT",
//       "merchant_info": { 
//         "email": "smith-facilitator@chilkatsoft.com"
//       },
//       "billing_info": [
//         { 
//           "email": "smith-buyer@chilkatsoft.com"
//         }
//       ],
//       "shipping_info": { 
//         "email": "smith-buyer@chilkatsoft.com",
//         "first_name": "Sally",
//         "last_name": "Patient",
//         "business_name": "Not applicable"
//       },
//       "invoice_date": "2016-11-15 PST",
//       "payment_term": { 
//         "due_date": "2016-12-30 PST"
//       },
//       "note": "Medical Invoice 16 Jul, 2013 PST",
//       "total_amount": { 
//         "currency": "USD",
//         "value": "500.00"
//       },
//       "metadata": { 
//         "created_date": "2016-11-15 06:17:03 PST",
//         "payer_view_url": "https://www.sandbox.paypal.com/cgi_bin/webscr?cmd=_pay-inv&viewtype=altview&id=INV2-ZG2H-HKAW-PMWU-N6ZR"
//       },
//       "paid_amount": { 
//         "paypal": { 
//           "currency": "USD",
//           "value": "0.00"
//         },
//         "other": { 
//           "currency": "USD",
//           "value": "0.00"
//         }
//       },
//       "refunded_amount": { 
//         "paypal": { 
//           "currency": "USD",
//           "value": "0.00"
//         },
//         "other": { 
//           "currency": "USD",
//           "value": "0.00"
//         }
//       },
//       "links": [
//         { 
//           "rel": "self",
//           "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR",
//           "method": "GET"
//         },
//         { 
//           "rel": "update",
//           "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/update",
//           "method": "PUT"
//         },
//         { 
//           "rel": "cancel",
//           "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/remind",
//           "method": "POST"
//         },
//         { 
//           "rel": "remind",
//           "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/cancel",
//           "method": "POST"
//         },
//         { 
//           "rel": "record-payment",
//           "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/record-payment",
//           "method": "POST"
//         },
//         { 
//           "rel": "qr-code",
//           "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/qr-code",
//           "method": "GET"
//         }
//       ]
//     }
//   ]
// }
//