Xojo Plugin
Xojo Plugin
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 Xojo Plugin Downloads
Dim success As Boolean
success = 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)
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
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..
// ----------------------------------------------------------------------------------------------
// First create the JSON with updated information:
Dim json As New Chilkat.JsonObject
json.EmitCompact = False
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")
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 PUT request containign the JSON in the request body, and get the JSON response.
Dim sbJsonRequest As New Chilkat.StringBuilder
success = json.EmitSb(sbJsonRequest)
Dim sbJsonResponse As New Chilkat.StringBuilder
success = rest.FullRequestSb("PUT",sbPath.GetAsString(),sbJsonRequest,sbJsonResponse)
If (success <> True) Then
System.DebugLog(rest.LastErrorText)
Return
End If
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.")