(Tcl) PayPal - Show Invoice Details

Shows details for a PayPal invoice, by ID.

See also PayPal Show Invoice Details REST API Reference

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# 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)
set jsonToken [new_CkJsonObject]

CkJsonObject_LoadFile $jsonToken "qa_data/tokens/paypal.json"

# Build the Authorization request header field value.
set sbAuth [new_CkStringBuilder]

# token_type should be "Bearer"
CkStringBuilder_Append $sbAuth [CkJsonObject_stringOf $jsonToken "token_type"]
CkStringBuilder_Append $sbAuth " "
CkStringBuilder_Append $sbAuth [CkJsonObject_stringOf $jsonToken "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.
set rest [new_CkRest]

set bAutoReconnect 1
set success [CkRest_Connect $rest "api.sandbox.paypal.com" 443 1 $bAutoReconnect]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkStringBuilder $sbAuth
    delete_CkRest $rest
    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..
# ----------------------------------------------------------------------------------------------

CkRest_AddHeader $rest "Authorization" [CkStringBuilder_getAsString $sbAuth]

set invoiceId "INV2-XV4B-736P-PLVN-SZCE"

set sbPath [new_CkStringBuilder]

CkStringBuilder_Append $sbPath "/v1/invoicing/invoices/"
CkStringBuilder_Append $sbPath $invoiceId

# Send the GET request and get the JSON response.
set sbJsonResponse [new_CkStringBuilder]

set success [CkRest_FullRequestNoBodySb $rest "GET" [CkStringBuilder_getAsString $sbPath] $sbJsonResponse]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkStringBuilder $sbAuth
    delete_CkRest $rest
    delete_CkStringBuilder $sbPath
    delete_CkStringBuilder $sbJsonResponse
    exit
}

set json [new_CkJsonObject]

CkJsonObject_put_EmitCompact $json 0
CkJsonObject_LoadSb $json $sbJsonResponse

puts "Response Status Code = [CkRest_get_ResponseStatusCode $rest]"

# Did we get a 200 success response?
if {[CkRest_get_ResponseStatusCode $rest] != 200} then {
    puts [CkJsonObject_emit $json]
    puts "Failed."
    delete_CkJsonObject $jsonToken
    delete_CkStringBuilder $sbAuth
    delete_CkRest $rest
    delete_CkStringBuilder $sbPath
    delete_CkStringBuilder $sbJsonResponse
    delete_CkJsonObject $json
    exit
}

# Sample response JSON is shown below.

# Get some information..
puts "email: [CkJsonObject_stringOf $json merchant_info.email]"
puts "business_name: [CkJsonObject_stringOf $json merchant_info.business_name]"

set numItems [CkJsonObject_SizeOfArray $json "items"]
set i 0
while {$i < $numItems} {
    CkJsonObject_put_I $json $i
    puts "item name: [CkJsonObject_stringOf $json {items[i].name}]"
    puts "item quantity: [CkJsonObject_stringOf $json {items[i].quantity}]"
    puts "item currency: [CkJsonObject_stringOf $json {items[i].unit_price.currency}]"
    puts "item value: [CkJsonObject_stringOf $json {items[i].unit_price.value}]"
    puts "----"
    set i [expr $i + 1]
}

puts "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"
# 	    }
# 	  ]
# 	}
# 

delete_CkJsonObject $jsonToken
delete_CkStringBuilder $sbAuth
delete_CkRest $rest
delete_CkStringBuilder $sbPath
delete_CkStringBuilder $sbJsonResponse
delete_CkJsonObject $json