Lua Requires Chilkat v9.5.0.65+

PayPal - Update Invoice

See more PayPal Examples

Update a PayPal invoice.

See also PayPal Update Invoice REST API Reference

Lua

local chilkat = require("chilkat")

-- 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)
local jsonToken = chilkat.JsonObject.new()
jsonToken:load_file("qa_data/tokens/paypal.json")

-- Build the Authorization request header field value.
local sbAuth = chilkat.StringBuilder.new()
-- token_type should be "Bearer"
sbAuth:append(jsonToken:string_of("token_type"))
sbAuth:append(" ")
sbAuth:append(jsonToken:string_of("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.
local rest = chilkat.Rest.new()
local bAutoReconnect = true
local success = rest:connect("api.sandbox.paypal.com", 443, true, bAutoReconnect)
if not success then
    print(rest.last_error_text)
    return
end

-- ----------------------------------------------------------------------------------------------
-- 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:

local json = chilkat.JsonObject.new()
json.emit_compact = false
json:update_string("merchant_info.email", "smith-facilitator@chilkatsoft.com")
json:update_string("merchant_info.first_name", "Joe")
json:update_string("merchant_info.last_name", "Facilitator")
json:update_string("merchant_info.business_name", "Medical Professionals, LLC")
json:update_string("merchant_info.phone.country_code", "001")
json:update_string("merchant_info.phone.national_number", "5032141716")
json:update_string("merchant_info.address.line1", "1234 Main St.")
json:update_string("merchant_info.address.city", "Portland")
json:update_string("merchant_info.address.state", "OR")
json:update_string("merchant_info.address.postal_code", "97217")
json:update_string("merchant_info.address.country_code", "US")
json:update_string("billing_info[0].email", "smith-buyer@chilkatsoft.com")
json:update_string("shipping_info.first_name", "Sally")
json:update_string("shipping_info.last_name", "Patient")
json:update_string("shipping_info.business_name", "Not applicable")
json:update_string("shipping_info.phone.country_code", "001")
json:update_string("shipping_info.phone.national_number", "5039871234")
json:update_string("shipping_info.address.line1", "1234 Broad St.")
json:update_string("shipping_info.address.city", "Portland")
json:update_string("shipping_info.address.state", "OR")
json:update_string("shipping_info.address.postal_code", "97216")
json:update_string("shipping_info.address.country_code", "US")
json:update_string("items[0].name", "Sutures")
-- We are updating the quantity from 100.0 to 200.0
json:update_number("items[0].quantity", "200.0")
json:update_string("items[0].unit_price.currency", "USD")
json:update_string("items[0].unit_price.value", "5.00")
json:update_string("payment_term.term_type", "NET_45")
json:update_string("payment_term.due_date", "2016-12-30 PST")
json:update_string("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:add_header("Authorization", sbAuth:get_as_string())
rest:add_header("Content-Type", "application/json")

local invoiceId = "INV2-XV4B-736P-PLVN-SZCE"

local sbPath = chilkat.StringBuilder.new()
sbPath:append("/v1/invoicing/invoices/")
sbPath:append(invoiceId)

-- Send the PUT request containign the JSON in the request body, and get the JSON response.
local sbJsonRequest = chilkat.StringBuilder.new()
json:emit_sb(sbJsonRequest)
local sbJsonResponse = chilkat.StringBuilder.new()
success = rest:full_request_sb("PUT", sbPath:get_as_string(), sbJsonRequest, sbJsonResponse)
if not success then
    print(rest.last_error_text)
    return
end

json:load_sb(sbJsonResponse)

print("Response Status Code = " .. rest.response_status_code)

-- Did we get a 200 success response?
if rest.response_status_code ~= 200 then
    print(json:emit())
    print("Failed.")
    return
end

-- Sample response JSON is shown below.

-- Get some information..
print("email: " .. json:string_of("merchant_info.email"))
print("business_name: " .. json:string_of("merchant_info.business_name"))

local numItems = json:size_of_array("items")
local i = 0
while i < numItems do
    json.i = i
    print("item name: " .. json:string_of("items[i].name"))
    print("item quantity: " .. json:string_of("items[i].quantity"))
    print("item currency: " .. json:string_of("items[i].unit_price.currency"))
    print("item value: " .. json:string_of("items[i].unit_price.value"))
    print("----")
    i = i + 1
end

print("Success.")