VBScript
VBScript
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
Chilkat VBScript Downloads
Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)
success = 0
' 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)
set jsonToken = CreateObject("Chilkat.JsonObject")
success = jsonToken.LoadFile("qa_data/tokens/paypal.json")
' Build the Authorization request header field value.
set sbAuth = CreateObject("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.
set rest = CreateObject("Chilkat.Rest")
bAutoReconnect = 1
success = rest.Connect("api.sandbox.paypal.com",443,1,bAutoReconnect)
If (success <> 1) Then
outFile.WriteLine(rest.LastErrorText)
WScript.Quit
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..
' ----------------------------------------------------------------------------------------------
' First create the JSON with updated information:
set json = CreateObject("Chilkat.JsonObject")
json.EmitCompact = 0
success = json.UpdateString("merchant_info.email","smith-facilitator@chilkatsoft.com")
success = json.UpdateString("merchant_info.first_name","Joe")
success = json.UpdateString("merchant_info.last_name","Facilitator")
success = json.UpdateString("merchant_info.business_name","Medical Professionals, LLC")
success = json.UpdateString("merchant_info.phone.country_code","001")
success = json.UpdateString("merchant_info.phone.national_number","5032141716")
success = json.UpdateString("merchant_info.address.line1","1234 Main St.")
success = json.UpdateString("merchant_info.address.city","Portland")
success = json.UpdateString("merchant_info.address.state","OR")
success = json.UpdateString("merchant_info.address.postal_code","97217")
success = json.UpdateString("merchant_info.address.country_code","US")
success = json.UpdateString("billing_info[0].email","smith-buyer@chilkatsoft.com")
success = json.UpdateString("shipping_info.first_name","Sally")
success = json.UpdateString("shipping_info.last_name","Patient")
success = json.UpdateString("shipping_info.business_name","Not applicable")
success = json.UpdateString("shipping_info.phone.country_code","001")
success = json.UpdateString("shipping_info.phone.national_number","5039871234")
success = json.UpdateString("shipping_info.address.line1","1234 Broad St.")
success = json.UpdateString("shipping_info.address.city","Portland")
success = json.UpdateString("shipping_info.address.state","OR")
success = json.UpdateString("shipping_info.address.postal_code","97216")
success = json.UpdateString("shipping_info.address.country_code","US")
success = json.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
success = json.UpdateNumber("items[0].quantity","200.0")
success = json.UpdateString("items[0].unit_price.currency","USD")
success = json.UpdateString("items[0].unit_price.value","5.00")
success = json.UpdateString("payment_term.term_type","NET_45")
success = json.UpdateString("payment_term.due_date","2016-12-30 PST")
success = json.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"
' }
success = rest.AddHeader("Authorization",sbAuth.GetAsString())
success = rest.AddHeader("Content-Type","application/json")
invoiceId = "INV2-XV4B-736P-PLVN-SZCE"
set sbPath = CreateObject("Chilkat.StringBuilder")
success = sbPath.Append("/v1/invoicing/invoices/")
success = sbPath.Append(invoiceId)
' Send the PUT request containign the JSON in the request body, and get the JSON response.
set sbJsonRequest = CreateObject("Chilkat.StringBuilder")
success = json.EmitSb(sbJsonRequest)
set sbJsonResponse = CreateObject("Chilkat.StringBuilder")
success = rest.FullRequestSb("PUT",sbPath.GetAsString(),sbJsonRequest,sbJsonResponse)
If (success <> 1) Then
outFile.WriteLine(rest.LastErrorText)
WScript.Quit
End If
success = json.LoadSb(sbJsonResponse)
outFile.WriteLine("Response Status Code = " & rest.ResponseStatusCode)
' Did we get a 200 success response?
If (rest.ResponseStatusCode <> 200) Then
outFile.WriteLine(json.Emit())
outFile.WriteLine("Failed.")
WScript.Quit
End If
' Sample response JSON is shown below.
' Get some information..
outFile.WriteLine("email: " & json.StringOf("merchant_info.email"))
outFile.WriteLine("business_name: " & json.StringOf("merchant_info.business_name"))
numItems = json.SizeOfArray("items")
i = 0
Do While i < numItems
json.I = i
outFile.WriteLine("item name: " & json.StringOf("items[i].name"))
outFile.WriteLine("item quantity: " & json.StringOf("items[i].quantity"))
outFile.WriteLine("item currency: " & json.StringOf("items[i].unit_price.currency"))
outFile.WriteLine("item value: " & json.StringOf("items[i].unit_price.value"))
outFile.WriteLine("----")
i = i + 1
Loop
outFile.WriteLine("Success.")
outFile.Close