Lua Requires Chilkat v9.5.0.64+

PayPal - Show Invoice Details

See more PayPal Examples

Shows details for a PayPal invoice, by ID.

See also PayPal Show Invoice Details 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..
-- ----------------------------------------------------------------------------------------------

rest:add_header("Authorization", sbAuth:get_as_string())

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

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

-- Send the GET request and get the JSON response.
local sbJsonResponse = chilkat.StringBuilder.new()
success = rest:full_request_no_body_sb("GET", sbPath:get_as_string(), sbJsonResponse)
if not success then
    print(rest.last_error_text)
    return
end

local json = chilkat.JsonObject.new()
json.emit_compact = false
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.")

-- ---------------------------------------------------
-- A sample response:

--     {
--       "id": "INV2-XV4B-736P-PLVN-SZCE",
--       "number": "0002",
--       "template_id": "TEMP-8HS37702UW384535K",
--       "status": "DRAFT",
--       "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": 100.0,
--           "unit_price": {
--             "currency": "USD",
--             "value": "5.00"
--           }
--         }
--       ],
--       "invoice_date": "2016-11-15 PST",
--       "payment_term": {
--         "term_type": "NET_45",
--         "due_date": "2016-12-30 PST"
--       },
--       "tax_calculated_after_discount": false,
--       "tax_inclusive": false,
--       "note": "Medical Invoice 16 Jul, 2013 PST",
--       "total_amount": {
--         "currency": "USD",
--         "value": "500.00"
--       },
--       "metadata": {
--         "created_date": "2016-11-15 08:09:21 PST"
--       },
--       "links": [
--         {
--           "rel": "self",
--           "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE",
--           "method": "GET"
--         },
--         {
--           "rel": "send",
--           "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE/send",
--           "method": "POST"
--         },
--         {
--           "rel": "update",
--           "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE/update",
--           "method": "PUT"
--         },
--         {
--           "rel": "delete",
--           "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE",
--           "method": "DELETE"
--         }
--       ]
--     }
--