AutoIt

PayPal - Show Invoice Details

See more PayPal Examples

Shows details for a PayPal invoice, by ID.

See also PayPal Show Invoice Details REST API Reference

AutoIt

Local $bSuccess = False

; 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)
$oJsonToken = ObjCreate("Chilkat.JsonObject")
$oJsonToken.LoadFile("qa_data/tokens/paypal.json")

; Build the Authorization request header field value.
$oSbAuth = ObjCreate("Chilkat.StringBuilder")
; token_type should be "Bearer"
$oSbAuth.Append($oJsonToken.StringOf("token_type"))
$oSbAuth.Append(" ")
$oSbAuth.Append($oJsonToken.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.
$oRest = ObjCreate("Chilkat.Rest")
Local $bAutoReconnect = True
$bSuccess = $oRest.Connect("api.sandbox.paypal.com",443,True,$bAutoReconnect)
If ($bSuccess <> True) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

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

$oRest.AddHeader("Authorization",$oSbAuth.GetAsString())

Local $sInvoiceId = "INV2-XV4B-736P-PLVN-SZCE"

$oSbPath = ObjCreate("Chilkat.StringBuilder")
$oSbPath.Append("/v1/invoicing/invoices/")
$oSbPath.Append($sInvoiceId)

; Send the GET request and get the JSON response.
$oSbJsonResponse = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oRest.FullRequestNoBodySb("GET",$oSbPath.GetAsString(),$oSbJsonResponse)
If ($bSuccess <> True) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.EmitCompact = False
$oJson.LoadSb($oSbJsonResponse)

ConsoleWrite("Response Status Code = " & $oRest.ResponseStatusCode & @CRLF)

; Did we get a 200 success response?
If ($oRest.ResponseStatusCode <> 200) Then
    ConsoleWrite($oJson.Emit() & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

; Sample response JSON is shown below.

; Get some information..
ConsoleWrite("email: " & $oJson.StringOf("merchant_info.email") & @CRLF)
ConsoleWrite("business_name: " & $oJson.StringOf("merchant_info.business_name") & @CRLF)

Local $iNumItems = $oJson.SizeOfArray("items")
Local $i = 0
While $i < $iNumItems
    $oJson.I = $i
    ConsoleWrite("item name: " & $oJson.StringOf("items[i].name") & @CRLF)
    ConsoleWrite("item quantity: " & $oJson.StringOf("items[i].quantity") & @CRLF)
    ConsoleWrite("item currency: " & $oJson.StringOf("items[i].unit_price.currency") & @CRLF)
    ConsoleWrite("item value: " & $oJson.StringOf("items[i].unit_price.value") & @CRLF)
    ConsoleWrite("----" & @CRLF)
    $i = $i + 1
Wend

ConsoleWrite("Success." & @CRLF)

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