(PHP ActiveX) PayPal - Show Invoice Details

Shows details for a PayPal invoice, by ID.

See also PayPal Show Invoice Details REST API Reference

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows Note: The php_com_dotnet.dll may need to be enabled inside of php.ini.

<?php

// 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)
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jsonToken = new COM("Chilkat.JsonObject");
$jsonToken->LoadFile('qa_data/tokens/paypal.json');

// Build the Authorization request header field value.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbAuth = new COM("Chilkat.StringBuilder");
// 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.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Rest')
$rest = new COM("Chilkat.Rest");
$bAutoReconnect = 1;
$success = $rest->Connect('api.sandbox.paypal.com',443,1,$bAutoReconnect);
if ($success != 1) {
    print $rest->LastErrorText . "\n";
    exit;
}

// ----------------------------------------------------------------------------------------------
// 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',$sbAuth->getAsString());

$invoiceId = 'INV2-XV4B-736P-PLVN-SZCE';

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbPath = new COM("Chilkat.StringBuilder");
$sbPath->Append('/v1/invoicing/invoices/');
$sbPath->Append($invoiceId);

// Send the GET request and get the JSON response.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbJsonResponse = new COM("Chilkat.StringBuilder");
$success = $rest->FullRequestNoBodySb('GET',$sbPath->getAsString(),$sbJsonResponse);
if ($success != 1) {
    print $rest->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->EmitCompact = 0;
$json->LoadSb($sbJsonResponse);

print 'Response Status Code = ' . $rest->ResponseStatusCode . "\n";

// Did we get a 200 success response?
if ($rest->ResponseStatusCode != 200) {
    print $json->emit() . "\n";
    print 'Failed.' . "\n";
    exit;
}

// Sample response JSON is shown below.

// Get some information..
print 'email: ' . $json->stringOf('merchant_info.email') . "\n";
print 'business_name: ' . $json->stringOf('merchant_info.business_name') . "\n";

$numItems = $json->SizeOfArray('items');
$i = 0;
while ($i < $numItems) {
    $json->I = $i;
    print 'item name: ' . $json->stringOf('items[i].name') . "\n";
    print 'item quantity: ' . $json->stringOf('items[i].quantity') . "\n";
    print 'item currency: ' . $json->stringOf('items[i].unit_price.currency') . "\n";
    print 'item value: ' . $json->stringOf('items[i].unit_price.value') . "\n";
    print '----' . "\n";
    $i = $i + 1;
}

print 'Success.' . "\n";

// ---------------------------------------------------
// 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"
// 	    }
// 	  ]
// 	}
// 

?>