B4X

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

B4X

Dim success As Boolean = 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 ChilkatJsonObject
jsonToken.Initialize
jsonToken.LoadFile("qa_data/tokens/paypal.json")

'  Build the Authorization request header field value.
Dim sbAuth As ChilkatStringBuilder
sbAuth.Initialize
'  token_type should be "Bearer"
sbAuth.Append(jsonToken.StringOf("token_type"))
sbAuth.Append(" ")
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 ChilkatRest
rest.Initialize("rest")
Dim bAutoReconnect As Boolean = True
success = rest.Connect("api.sandbox.paypal.com", 443, True, bAutoReconnect)
If success <> True Then
    Log(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 ChilkatJsonObject
json.Initialize
json.EmitCompact = False
json.UpdateString("merchant_info.email", "smith-facilitator@chilkatsoft.com")
json.UpdateString("merchant_info.first_name", "Joe")
json.UpdateString("merchant_info.last_name", "Facilitator")
json.UpdateString("merchant_info.business_name", "Medical Professionals, LLC")
json.UpdateString("merchant_info.phone.country_code", "001")
json.UpdateString("merchant_info.phone.national_number", "5032141716")
json.UpdateString("merchant_info.address.line1", "1234 Main St.")
json.UpdateString("merchant_info.address.city", "Portland")
json.UpdateString("merchant_info.address.state", "OR")
json.UpdateString("merchant_info.address.postal_code", "97217")
json.UpdateString("merchant_info.address.country_code", "US")
json.UpdateString("billing_info[0].email", "smith-buyer@chilkatsoft.com")
json.UpdateString("shipping_info.first_name", "Sally")
json.UpdateString("shipping_info.last_name", "Patient")
json.UpdateString("shipping_info.business_name", "Not applicable")
json.UpdateString("shipping_info.phone.country_code", "001")
json.UpdateString("shipping_info.phone.national_number", "5039871234")
json.UpdateString("shipping_info.address.line1", "1234 Broad St.")
json.UpdateString("shipping_info.address.city", "Portland")
json.UpdateString("shipping_info.address.state", "OR")
json.UpdateString("shipping_info.address.postal_code", "97216")
json.UpdateString("shipping_info.address.country_code", "US")
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
json.UpdateNumber("items[0].quantity", "200.0")
json.UpdateString("items[0].unit_price.currency", "USD")
json.UpdateString("items[0].unit_price.value", "5.00")
json.UpdateString("payment_term.term_type", "NET_45")
json.UpdateString("payment_term.due_date", "2016-12-30 PST")
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"
'  	}

rest.AddHeader("Authorization", sbAuth.GetAsString)
rest.AddHeader("Content-Type", "application/json")

Dim invoiceId As String = "INV2-XV4B-736P-PLVN-SZCE"

Dim sbPath As ChilkatStringBuilder
sbPath.Initialize
sbPath.Append("/v1/invoicing/invoices/")
sbPath.Append(invoiceId)

'  Send the PUT request containign the JSON in the request body, and get the JSON response.
Dim sbJsonRequest As ChilkatStringBuilder
sbJsonRequest.Initialize
json.EmitSb(sbJsonRequest)
Dim sbJsonResponse As ChilkatStringBuilder
sbJsonResponse.Initialize
success = rest.FullRequestSb("PUT", sbPath.GetAsString, sbJsonRequest, sbJsonResponse)
If success <> True Then
    Log(rest.LastErrorText)
    Return
End If


json.LoadSb(sbJsonResponse)

Log("Response Status Code = " & rest.ResponseStatusCode)

'  Did we get a 200 success response?
If rest.ResponseStatusCode <> 200 Then
    Log(json.Emit)
    Log("Failed.")
    Return
End If


'  Sample response JSON is shown below.

'  Get some information..
Log("email: " & json.StringOf("merchant_info.email"))
Log("business_name: " & json.StringOf("merchant_info.business_name"))

Dim numItems As Int = json.SizeOfArray("items")
Dim i As Int = 0
Do While i < numItems
    json.I = i
    Log("item name: " & json.StringOf("items[i].name"))
    Log("item quantity: " & json.StringOf("items[i].quantity"))
    Log("item currency: " & json.StringOf("items[i].unit_price.currency"))
    Log("item value: " & json.StringOf("items[i].unit_price.value"))
    Log("----")
    i = i + 1
Loop

Log("Success.")