(Tcl) PayPal List Merchant Invoices

List PayPal invoices.

See also PayPal List Invoices REST API Reference

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# Note: Requires Chilkat v9.5.0.64 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)
set jsonToken [new_CkJsonObject]

CkJsonObject_LoadFile $jsonToken "qa_data/tokens/paypal.json"

# Build the Authorization request header field value.
set sbAuth [new_CkStringBuilder]

# token_type should be "Bearer"
CkStringBuilder_Append $sbAuth [CkJsonObject_stringOf $jsonToken "token_type"]
CkStringBuilder_Append $sbAuth " "
CkStringBuilder_Append $sbAuth [CkJsonObject_stringOf $jsonToken "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.
set rest [new_CkRest]

set bAutoReconnect 1
set success [CkRest_Connect $rest "api.sandbox.paypal.com" 443 1 $bAutoReconnect]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkStringBuilder $sbAuth
    delete_CkRest $rest
    exit
}

# ----------------------------------------------------------------------------------------------
# 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..
# ----------------------------------------------------------------------------------------------

CkRest_AddHeader $rest "Authorization" [CkStringBuilder_getAsString $sbAuth]
CkRest_AddQueryParam $rest "page" "0"
CkRest_AddQueryParam $rest "page_size" "20"
CkRest_AddQueryParam $rest "total_count_required" "true"

# Send the GET request and get the JSON response.
set sbJsonResponse [new_CkStringBuilder]

set success [CkRest_FullRequestNoBodySb $rest "GET" "/v1/invoicing/invoices" $sbJsonResponse]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkStringBuilder $sbAuth
    delete_CkRest $rest
    delete_CkStringBuilder $sbJsonResponse
    exit
}

set json [new_CkJsonObject]

CkJsonObject_put_EmitCompact $json 0
CkJsonObject_LoadSb $json $sbJsonResponse

puts "Response Status Code = [CkRest_get_ResponseStatusCode $rest]"

# Did we get a 200 success response?
if {[CkRest_get_ResponseStatusCode $rest] != 200} then {
    puts [CkJsonObject_emit $json]
    puts "Failed."
    delete_CkJsonObject $jsonToken
    delete_CkStringBuilder $sbAuth
    delete_CkRest $rest
    delete_CkStringBuilder $sbJsonResponse
    delete_CkJsonObject $json
    exit
}

# Sample response JSON is shown below.

# Iterate over each invoice and get some information from each..
set numInvoices [CkJsonObject_SizeOfArray $json "invoices"]
set i 0
while {$i < $numInvoices} {
    CkJsonObject_put_I $json $i
    puts "Invoice ID: [CkJsonObject_stringOf $json {invoices[i].id}]"
    puts "Invoice Number: [CkJsonObject_stringOf $json {invoices[i].number}]"
    puts "Invoice Status: [CkJsonObject_stringOf $json {invoices[i].status}]"
    puts "Shipping First Name: [CkJsonObject_stringOf $json {invoices[i].shipping_info.first_name}]"
    set j 0
    set numBillingInfo [CkJsonObject_SizeOfArray $json "invoices[i].billing_info"]
    while {$j < $numBillingInfo} {
        CkJsonObject_put_J $json $j
        puts "billing_info email: [CkJsonObject_stringOf $json {invoices[i].billing_info[j].email}]"
        set j [expr $j + 1]
    }
    set numLinks [CkJsonObject_SizeOfArray $json "invoices[i].links"]
    set j 0
    while {$j < $numLinks} {
        CkJsonObject_put_J $json $j
        puts "link: [CkJsonObject_stringOf $json {invoices[i].links[j].href}]"
        set j [expr $j + 1]
    }
    puts "----"
    set i [expr $i + 1]
}

puts "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"
# 	    }
# 	  ]
# 	}
# 

delete_CkJsonObject $jsonToken
delete_CkStringBuilder $sbAuth
delete_CkRest $rest
delete_CkStringBuilder $sbJsonResponse
delete_CkJsonObject $json