(Lianja) PayPal - Update Invoice

Update a PayPal invoice.

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

See also PayPal Update Invoice REST API Reference

Chilkat Lianja Extension Download Chilkat Lianja Extension

// 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)
loJsonToken = createobject("CkJsonObject")
loJsonToken.LoadFile("qa_data/tokens/paypal.json")

// Build the Authorization request header field value.
loSbAuth = createobject("CkStringBuilder")
// token_type should be "Bearer"
loSbAuth.Append(loJsonToken.StringOf("token_type"))
loSbAuth.Append(" ")
loSbAuth.Append(loJsonToken.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.
loRest = createobject("CkRest")
llBAutoReconnect = .T.
llSuccess = loRest.Connect("api.sandbox.paypal.com",443,.T.,llBAutoReconnect)
if (llSuccess <> .T.) then
    ? loRest.LastErrorText
    release loJsonToken
    release loSbAuth
    release loRest
    return
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:

loJson = createobject("CkJsonObject")
loJson.EmitCompact = .F.
loJson.UpdateString("merchant_info.email","smith-facilitator@chilkatsoft.com")
loJson.UpdateString("merchant_info.first_name","Joe")
loJson.UpdateString("merchant_info.last_name","Facilitator")
loJson.UpdateString("merchant_info.business_name","Medical Professionals, LLC")
loJson.UpdateString("merchant_info.phone.country_code","001")
loJson.UpdateString("merchant_info.phone.national_number","5032141716")
loJson.UpdateString("merchant_info.address.line1","1234 Main St.")
loJson.UpdateString("merchant_info.address.city","Portland")
loJson.UpdateString("merchant_info.address.state","OR")
loJson.UpdateString("merchant_info.address.postal_code","97217")
loJson.UpdateString("merchant_info.address.country_code","US")
loJson.UpdateString("billing_info[0].email","smith-buyer@chilkatsoft.com")
loJson.UpdateString("shipping_info.first_name","Sally")
loJson.UpdateString("shipping_info.last_name","Patient")
loJson.UpdateString("shipping_info.business_name","Not applicable")
loJson.UpdateString("shipping_info.phone.country_code","001")
loJson.UpdateString("shipping_info.phone.national_number","5039871234")
loJson.UpdateString("shipping_info.address.line1","1234 Broad St.")
loJson.UpdateString("shipping_info.address.city","Portland")
loJson.UpdateString("shipping_info.address.state","OR")
loJson.UpdateString("shipping_info.address.postal_code","97216")
loJson.UpdateString("shipping_info.address.country_code","US")
loJson.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
loJson.UpdateNumber("items[0].quantity","200.0")
loJson.UpdateString("items[0].unit_price.currency","USD")
loJson.UpdateString("items[0].unit_price.value","5.00")
loJson.UpdateString("payment_term.term_type","NET_45")
loJson.UpdateString("payment_term.due_date","2016-12-30 PST")
loJson.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"
// 	}

loRest.AddHeader("Authorization",loSbAuth.GetAsString())
loRest.AddHeader("Content-Type","application/json")

lcInvoiceId = "INV2-XV4B-736P-PLVN-SZCE"

loSbPath = createobject("CkStringBuilder")
loSbPath.Append("/v1/invoicing/invoices/")
loSbPath.Append(lcInvoiceId)

// Send the PUT request containign the JSON in the request body, and get the JSON response.
loSbJsonRequest = createobject("CkStringBuilder")
loJson.EmitSb(loSbJsonRequest)
loSbJsonResponse = createobject("CkStringBuilder")
llSuccess = loRest.FullRequestSb("PUT",loSbPath.GetAsString(),loSbJsonRequest,loSbJsonResponse)
if (llSuccess <> .T.) then
    ? loRest.LastErrorText
    release loJsonToken
    release loSbAuth
    release loRest
    release loJson
    release loSbPath
    release loSbJsonRequest
    release loSbJsonResponse
    return
endif

loJson.LoadSb(loSbJsonResponse)

? "Response Status Code = " + str(loRest.ResponseStatusCode)

// Did we get a 200 success response?
if (loRest.ResponseStatusCode <> 200) then
    ? loJson.Emit()
    ? "Failed."
    release loJsonToken
    release loSbAuth
    release loRest
    release loJson
    release loSbPath
    release loSbJsonRequest
    release loSbJsonResponse
    return
endif

// Sample response JSON is shown below.

// Get some information..
? "email: " + loJson.StringOf("merchant_info.email")
? "business_name: " + loJson.StringOf("merchant_info.business_name")

lnNumItems = loJson.SizeOfArray("items")
i = 0
do while i < lnNumItems
    loJson.I = i
    ? "item name: " + loJson.StringOf("items[i].name")
    ? "item quantity: " + loJson.StringOf("items[i].quantity")
    ? "item currency: " + loJson.StringOf("items[i].unit_price.currency")
    ? "item value: " + loJson.StringOf("items[i].unit_price.value")
    ? "----"
    i = i + 1
enddo

? "Success."


release loJsonToken
release loSbAuth
release loRest
release loJson
release loSbPath
release loSbJsonRequest
release loSbJsonResponse