AutoIt

PayPal - Update Invoice

See more PayPal Examples

Update a PayPal invoice.

Note: This example requires Chilkat v9.5.0.65 or greater.

See also PayPal Update Invoice REST API Reference

AutoIt

Local $bSuccess = False

; Note: Requires Chilkat v9.5.0.65 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..
; ----------------------------------------------------------------------------------------------

; First create the JSON with updated information:

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.EmitCompact = False
$oJson.UpdateString("merchant_info.email","smith-facilitator@chilkatsoft.com")
$oJson.UpdateString("merchant_info.first_name","Joe")
$oJson.UpdateString("merchant_info.last_name","Facilitator")
$oJson.UpdateString("merchant_info.business_name","Medical Professionals, LLC")
$oJson.UpdateString("merchant_info.phone.country_code","001")
$oJson.UpdateString("merchant_info.phone.national_number","5032141716")
$oJson.UpdateString("merchant_info.address.line1","1234 Main St.")
$oJson.UpdateString("merchant_info.address.city","Portland")
$oJson.UpdateString("merchant_info.address.state","OR")
$oJson.UpdateString("merchant_info.address.postal_code","97217")
$oJson.UpdateString("merchant_info.address.country_code","US")
$oJson.UpdateString("billing_info[0].email","smith-buyer@chilkatsoft.com")
$oJson.UpdateString("shipping_info.first_name","Sally")
$oJson.UpdateString("shipping_info.last_name","Patient")
$oJson.UpdateString("shipping_info.business_name","Not applicable")
$oJson.UpdateString("shipping_info.phone.country_code","001")
$oJson.UpdateString("shipping_info.phone.national_number","5039871234")
$oJson.UpdateString("shipping_info.address.line1","1234 Broad St.")
$oJson.UpdateString("shipping_info.address.city","Portland")
$oJson.UpdateString("shipping_info.address.state","OR")
$oJson.UpdateString("shipping_info.address.postal_code","97216")
$oJson.UpdateString("shipping_info.address.country_code","US")
$oJson.UpdateString("items[0].name","Sutures")
; We are updating the quantity from 100.0 to 200.0
; Note: The UpdateNumber method is added in v9.5.0.65
$oJson.UpdateNumber("items[0].quantity","200.0")
$oJson.UpdateString("items[0].unit_price.currency","USD")
$oJson.UpdateString("items[0].unit_price.value","5.00")
$oJson.UpdateString("payment_term.term_type","NET_45")
$oJson.UpdateString("payment_term.due_date","2016-12-30 PST")
$oJson.UpdateString("note","Medical Invoice 16 Jul, 2013 PST")

; The JSON created by the above code is this:

; 	{ 
; 	  "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": 200.0,
; 	      "unit_price": { 
; 	        "currency": "USD",
; 	        "value": "5.00"
; 	      }
; 	    }
; 	  ],
; 	  "payment_term": { 
; 	    "term_type": "NET_45",
; 	    "due_date": "2016-12-30 PST"
; 	  },
; 	  "note": "Medical Invoice 16 Jul, 2013 PST"
; 	}

$oRest.AddHeader("Authorization",$oSbAuth.GetAsString())
$oRest.AddHeader("Content-Type","application/json")

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

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

; Send the PUT request containign the JSON in the request body, and get the JSON response.
$oSbJsonRequest = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbJsonRequest)
$oSbJsonResponse = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oRest.FullRequestSb("PUT",$oSbPath.GetAsString(),$oSbJsonRequest,$oSbJsonResponse)
If ($bSuccess <> True) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

$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)