(Excel) PayPal List Merchant Invoices

List PayPal invoices.

See also PayPal List Invoices REST API Reference

Download Excel Class Modules Chilkat Excel Class Modules

' 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)
Dim jsonToken As Chilkat.JsonObject
Set jsonToken = Chilkat.NewJsonObject
Dim success As Boolean
success = jsonToken.LoadFile("qa_data/tokens/paypal.json")

' Build the Authorization request header field value.
Dim sbAuth As Chilkat.StringBuilder
Set sbAuth = Chilkat.NewStringBuilder
' token_type should be "Bearer"
success = sbAuth.Append(jsonToken.StringOf("token_type"))
success = sbAuth.Append(" ")
success = sbAuth.Append(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.
Dim rest As Chilkat.Rest
Set rest = Chilkat.NewRest

bAutoReconnect = True

success = rest.Connect("api.sandbox.paypal.com",443,True,bAutoReconnect)
If (success <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
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..
' ----------------------------------------------------------------------------------------------

success = rest.AddHeader("Authorization",sbAuth.GetAsString())
success = rest.AddQueryParam("page","0")
success = rest.AddQueryParam("page_size","20")
success = rest.AddQueryParam("total_count_required","true")

' Send the GET request and get the JSON response.
Dim sbJsonResponse As Chilkat.StringBuilder
Set sbJsonResponse = Chilkat.NewStringBuilder
success = rest.FullRequestNoBodySb("GET","/v1/invoicing/invoices",sbJsonResponse)
If (success <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

Dim json As Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
json.EmitCompact = False
success = json.LoadSb(sbJsonResponse)

Debug.Print "Response Status Code = "; rest.ResponseStatusCode

' Did we get a 200 success response?
If (rest.ResponseStatusCode <> 200) Then
    Debug.Print json.Emit()
    Debug.Print "Failed."
    Exit Sub
End If

' Sample response JSON is shown below.

' Iterate over each invoice and get some information from each..

numInvoices = json.SizeOfArray("invoices")

i = 0
Do While i < numInvoices
    json.I = i
    Debug.Print "Invoice ID: "; json.StringOf("invoices[i].id")
    Debug.Print "Invoice Number: "; json.StringOf("invoices[i].number")
    Debug.Print "Invoice Status: "; json.StringOf("invoices[i].status")
    Debug.Print "Shipping First Name: "; json.StringOf("invoices[i].shipping_info.first_name")

    j = 0

    numBillingInfo = json.SizeOfArray("invoices[i].billing_info")
    Do While j < numBillingInfo
        json.J = j
        Debug.Print "billing_info email: "; json.StringOf("invoices[i].billing_info[j].email")
        j = j + 1
    Loop

    numLinks = json.SizeOfArray("invoices[i].links")
    j = 0
    Do While j < numLinks
        json.J = j
        Debug.Print "link: "; json.StringOf("invoices[i].links[j].href")
        j = j + 1
    Loop
    Debug.Print "----"
    i = i + 1
Loop

Debug.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"
' 	    }
' 	  ]
' 	}
'