Lua Requires Chilkat v9.5.0.64+
Lua
PayPal List Merchant Invoices
See more PayPal Examples
List PayPal invoices.See also PayPal List Invoices REST API Reference
Chilkat Lua Downloads
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())
rest:add_query_param("page", "0")
rest:add_query_param("page_size", "20")
rest:add_query_param("total_count_required", "true")
-- Send the GET request and get the JSON response.
local sbJsonResponse = chilkat.StringBuilder.new()
success = rest:full_request_no_body_sb("GET", "/v1/invoicing/invoices", 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.
-- Iterate over each invoice and get some information from each..
local numInvoices = json:size_of_array("invoices")
local i = 0
while i < numInvoices do
json.i = i
print("Invoice ID: " .. json:string_of("invoices[i].id"))
print("Invoice Number: " .. json:string_of("invoices[i].number"))
print("Invoice Status: " .. json:string_of("invoices[i].status"))
print("Shipping First Name: " .. json:string_of("invoices[i].shipping_info.first_name"))
local j = 0
local numBillingInfo = json:size_of_array("invoices[i].billing_info")
while j < numBillingInfo do
json.j = j
print("billing_info email: " .. json:string_of("invoices[i].billing_info[j].email"))
j = j + 1
end
local numLinks = json:size_of_array("invoices[i].links")
j = 0
while j < numLinks do
json.j = j
print("link: " .. json:string_of("invoices[i].links[j].href"))
j = j + 1
end
print("----")
i = i + 1
end
print("Success.")
-- {
-- "total_count": 2,
-- "invoices": [
-- {
-- "id": "INV2-XV4B-736P-PLVN-SZCE",
-- "number": "0002",
-- "status": "DRAFT",
-- "merchant_info": {
-- "email": "smith-facilitator@chilkatsoft.com"
-- },
-- "billing_info": [
-- {
-- "email": "smith-buyer@chilkatsoft.com"
-- }
-- ],
-- "shipping_info": {
-- "email": "smith-buyer@chilkatsoft.com",
-- "first_name": "Sally",
-- "last_name": "Patient",
-- "business_name": "Not applicable"
-- },
-- "invoice_date": "2016-11-15 PST",
-- "payment_term": {
-- "due_date": "2016-12-30 PST"
-- },
-- "note": "Medical Invoice 16 Jul, 2013 PST",
-- "total_amount": {
-- "currency": "USD",
-- "value": "500.00"
-- },
-- "metadata": {
-- "created_date": "2016-11-15 08:09:21 PST"
-- },
-- "paid_amount": {
-- "paypal": {
-- "currency": "USD",
-- "value": "0.00"
-- },
-- "other": {
-- "currency": "USD",
-- "value": "0.00"
-- }
-- },
-- "refunded_amount": {
-- "paypal": {
-- "currency": "USD",
-- "value": "0.00"
-- },
-- "other": {
-- "currency": "USD",
-- "value": "0.00"
-- }
-- },
-- "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"
-- }
-- ]
-- },
-- {
-- "id": "INV2-ZG2H-HKAW-PMWU-N6ZR",
-- "number": "0001",
-- "status": "SENT",
-- "merchant_info": {
-- "email": "smith-facilitator@chilkatsoft.com"
-- },
-- "billing_info": [
-- {
-- "email": "smith-buyer@chilkatsoft.com"
-- }
-- ],
-- "shipping_info": {
-- "email": "smith-buyer@chilkatsoft.com",
-- "first_name": "Sally",
-- "last_name": "Patient",
-- "business_name": "Not applicable"
-- },
-- "invoice_date": "2016-11-15 PST",
-- "payment_term": {
-- "due_date": "2016-12-30 PST"
-- },
-- "note": "Medical Invoice 16 Jul, 2013 PST",
-- "total_amount": {
-- "currency": "USD",
-- "value": "500.00"
-- },
-- "metadata": {
-- "created_date": "2016-11-15 06:17:03 PST",
-- "payer_view_url": "https://www.sandbox.paypal.com/cgi_bin/webscr?cmd=_pay-inv&viewtype=altview&id=INV2-ZG2H-HKAW-PMWU-N6ZR"
-- },
-- "paid_amount": {
-- "paypal": {
-- "currency": "USD",
-- "value": "0.00"
-- },
-- "other": {
-- "currency": "USD",
-- "value": "0.00"
-- }
-- },
-- "refunded_amount": {
-- "paypal": {
-- "currency": "USD",
-- "value": "0.00"
-- },
-- "other": {
-- "currency": "USD",
-- "value": "0.00"
-- }
-- },
-- "links": [
-- {
-- "rel": "self",
-- "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR",
-- "method": "GET"
-- },
-- {
-- "rel": "update",
-- "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/update",
-- "method": "PUT"
-- },
-- {
-- "rel": "cancel",
-- "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/remind",
-- "method": "POST"
-- },
-- {
-- "rel": "remind",
-- "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/cancel",
-- "method": "POST"
-- },
-- {
-- "rel": "record-payment",
-- "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/record-payment",
-- "method": "POST"
-- },
-- {
-- "rel": "qr-code",
-- "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/qr-code",
-- "method": "GET"
-- }
-- ]
-- }
-- ],
-- "links": [
-- {
-- "rel": "self",
-- "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices?page=0&page_size=20&total_count_required=true",
-- "method": "GET"
-- }
-- ]
-- }
--