(Xojo Plugin) PayPal - Show Invoice Details

Shows details for a PayPal invoice, by ID.

See also PayPal Show Invoice Details REST API Reference

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

// 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)
Dim jsonToken As New Chilkat.JsonObject
success = jsonToken.LoadFile("qa_data/tokens/paypal.json")

// Build the Authorization request header field value.
Dim sbAuth As New Chilkat.StringBuilder
// token_type should be "Bearer"
success = sbAuth.Append(jsonToken.StringOf("token_type"))
success = sbAuth.Append(" ")
success = 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.
Dim rest As New Chilkat.Rest
Dim bAutoReconnect As Boolean
bAutoReconnect = True
Dim success As Boolean
success = rest.Connect("api.sandbox.paypal.com",443,True,bAutoReconnect)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

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

success = rest.AddHeader("Authorization",sbAuth.GetAsString())

Dim invoiceId As String
invoiceId = "INV2-XV4B-736P-PLVN-SZCE"

Dim sbPath As New Chilkat.StringBuilder
success = sbPath.Append("/v1/invoicing/invoices/")
success = sbPath.Append(invoiceId)

// Send the GET request and get the JSON response.
Dim sbJsonResponse As New Chilkat.StringBuilder
success = rest.FullRequestNoBodySb("GET",sbPath.GetAsString(),sbJsonResponse)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

Dim json As New Chilkat.JsonObject
json.EmitCompact = False
success = json.LoadSb(sbJsonResponse)

System.DebugLog("Response Status Code = " + Str(rest.ResponseStatusCode))

// Did we get a 200 success response?
If (rest.ResponseStatusCode <> 200) Then
    System.DebugLog(json.Emit())
    System.DebugLog("Failed.")
    Return
End If

// Sample response JSON is shown below.

// Get some information..
System.DebugLog("email: " + json.StringOf("merchant_info.email"))
System.DebugLog("business_name: " + json.StringOf("merchant_info.business_name"))

Dim numItems As Int32
numItems = json.SizeOfArray("items")
Dim i As Int32
i = 0
While i < numItems
    json.I = i
    System.DebugLog("item name: " + json.StringOf("items[i].name"))
    System.DebugLog("item quantity: " + json.StringOf("items[i].quantity"))
    System.DebugLog("item currency: " + json.StringOf("items[i].unit_price.currency"))
    System.DebugLog("item value: " + json.StringOf("items[i].unit_price.value"))
    System.DebugLog("----")
    i = i + 1
Wend

System.DebugLog("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"
// 	    }
// 	  ]
// 	}
//