(PowerBuilder) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

integer li_rc
oleobject loo_JsonToken
oleobject loo_SbAuth
oleobject loo_Rest
integer li_BAutoReconnect
integer li_Success
oleobject loo_Json
string ls_InvoiceId
oleobject loo_SbPath
oleobject loo_SbJsonRequest
oleobject loo_SbJsonResponse
integer li_NumItems
integer i

// 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)
loo_JsonToken = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JsonToken.ConnectToNewObject("Chilkat.JsonObject")
if li_rc < 0 then
    destroy loo_JsonToken
    MessageBox("Error","Connecting to COM object failed")
    return
end if
loo_JsonToken.LoadFile("qa_data/tokens/paypal.json")

// Build the Authorization request header field value.
loo_SbAuth = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbAuth.ConnectToNewObject("Chilkat.StringBuilder")

// token_type should be "Bearer"
loo_SbAuth.Append(loo_JsonToken.StringOf("token_type"))
loo_SbAuth.Append(" ")
loo_SbAuth.Append(loo_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.
loo_Rest = create oleobject
// Use "Chilkat_9_5_0.Rest" for versions of Chilkat < 10.0.0
li_rc = loo_Rest.ConnectToNewObject("Chilkat.Rest")

li_BAutoReconnect = 1
li_Success = loo_Rest.Connect("api.sandbox.paypal.com",443,1,li_BAutoReconnect)
if li_Success <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_JsonToken
    destroy loo_SbAuth
    destroy loo_Rest
    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:

loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

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

loo_Rest.AddHeader("Authorization",loo_SbAuth.GetAsString())
loo_Rest.AddHeader("Content-Type","application/json")

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

loo_SbPath = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbPath.ConnectToNewObject("Chilkat.StringBuilder")

loo_SbPath.Append("/v1/invoicing/invoices/")
loo_SbPath.Append(ls_InvoiceId)

// Send the PUT request containign the JSON in the request body, and get the JSON response.
loo_SbJsonRequest = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbJsonRequest.ConnectToNewObject("Chilkat.StringBuilder")

loo_Json.EmitSb(loo_SbJsonRequest)
loo_SbJsonResponse = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbJsonResponse.ConnectToNewObject("Chilkat.StringBuilder")

li_Success = loo_Rest.FullRequestSb("PUT",loo_SbPath.GetAsString(),loo_SbJsonRequest,loo_SbJsonResponse)
if li_Success <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_JsonToken
    destroy loo_SbAuth
    destroy loo_Rest
    destroy loo_Json
    destroy loo_SbPath
    destroy loo_SbJsonRequest
    destroy loo_SbJsonResponse
    return
end if

loo_Json.LoadSb(loo_SbJsonResponse)

Write-Debug "Response Status Code = " + string(loo_Rest.ResponseStatusCode)

// Did we get a 200 success response?
if loo_Rest.ResponseStatusCode <> 200 then
    Write-Debug loo_Json.Emit()
    Write-Debug "Failed."
    destroy loo_JsonToken
    destroy loo_SbAuth
    destroy loo_Rest
    destroy loo_Json
    destroy loo_SbPath
    destroy loo_SbJsonRequest
    destroy loo_SbJsonResponse
    return
end if

// Sample response JSON is shown below.

// Get some information..
Write-Debug "email: " + loo_Json.StringOf("merchant_info.email")
Write-Debug "business_name: " + loo_Json.StringOf("merchant_info.business_name")

li_NumItems = loo_Json.SizeOfArray("items")
i = 0
do while i < li_NumItems
    loo_Json.I = i
    Write-Debug "item name: " + loo_Json.StringOf("items[i].name")
    Write-Debug "item quantity: " + loo_Json.StringOf("items[i].quantity")
    Write-Debug "item currency: " + loo_Json.StringOf("items[i].unit_price.currency")
    Write-Debug "item value: " + loo_Json.StringOf("items[i].unit_price.value")
    Write-Debug "----"
    i = i + 1
loop

Write-Debug "Success."


destroy loo_JsonToken
destroy loo_SbAuth
destroy loo_Rest
destroy loo_Json
destroy loo_SbPath
destroy loo_SbJsonRequest
destroy loo_SbJsonResponse