(Visual FoxPro) PayPal List Merchant Invoices

List PayPal invoices.

Chilkat ActiveX Downloads

ActiveX for 32-bit and 64-bit Windows

LOCAL loJsonToken
LOCAL loSbAuth
LOCAL loRest
LOCAL lnBAutoReconnect
LOCAL lnSuccess
LOCAL loSbJsonResponse
LOCAL loJson
LOCAL lnNumInvoices
LOCAL i
LOCAL j
LOCAL lnNumBillingInfo
LOCAL lnNumLinks

* 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)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJsonToken = CreateObject('Chilkat.JsonObject')
loJsonToken.LoadFile("qa_data/tokens/paypal.json")

* Build the Authorization request header field value.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbAuth = CreateObject('Chilkat.StringBuilder')
* token_type should be "Bearer"
loSbAuth.Append(loJsonToken.StringOf("token_type"))
loSbAuth.Append(" ")
loSbAuth.Append(loJsonToken.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.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Rest')
loRest = CreateObject('Chilkat.Rest')
lnBAutoReconnect = 1
lnSuccess = loRest.Connect("api.sandbox.paypal.com",443,1,lnBAutoReconnect)
IF (lnSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loJsonToken
    RELEASE loSbAuth
    RELEASE loRest
    CANCEL
ENDIF

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

loRest.AddHeader("Authorization",loSbAuth.GetAsString())
loRest.AddQueryParam("page","0")
loRest.AddQueryParam("page_size","20")
loRest.AddQueryParam("total_count_required","true")

* Send the GET request and get the JSON response.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbJsonResponse = CreateObject('Chilkat.StringBuilder')
lnSuccess = loRest.FullRequestNoBodySb("GET","/v1/invoicing/invoices",loSbJsonResponse)
IF (lnSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loJsonToken
    RELEASE loSbAuth
    RELEASE loRest
    RELEASE loSbJsonResponse
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.EmitCompact = 0
loJson.LoadSb(loSbJsonResponse)

? "Response Status Code = " + STR(loRest.ResponseStatusCode)

* Did we get a 200 success response?
IF (loRest.ResponseStatusCode <> 200) THEN
    ? loJson.Emit()
    ? "Failed."
    RELEASE loJsonToken
    RELEASE loSbAuth
    RELEASE loRest
    RELEASE loSbJsonResponse
    RELEASE loJson
    CANCEL
ENDIF

* Sample response JSON is shown below.

* Iterate over each invoice and get some information from each..
lnNumInvoices = loJson.SizeOfArray("invoices")
i = 0
DO WHILE i < lnNumInvoices
    loJson.I = i
    ? "Invoice ID: " + loJson.StringOf("invoices[i].id")
    ? "Invoice Number: " + loJson.StringOf("invoices[i].number")
    ? "Invoice Status: " + loJson.StringOf("invoices[i].status")
    ? "Shipping First Name: " + loJson.StringOf("invoices[i].shipping_info.first_name")
    j = 0
    lnNumBillingInfo = loJson.SizeOfArray("invoices[i].billing_info")
    DO WHILE j < lnNumBillingInfo
        loJson.J = j
        ? "billing_info email: " + loJson.StringOf("invoices[i].billing_info[j].email")
        j = j + 1
    ENDDO
    lnNumLinks = loJson.SizeOfArray("invoices[i].links")
    j = 0
    DO WHILE j < lnNumLinks
        loJson.J = j
        ? "link: " + loJson.StringOf("invoices[i].links[j].href")
        j = j + 1
    ENDDO
    ? "----"
    i = i + 1
ENDDO

? "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"
* 	    }
* 	  ]
* 	}
* 

RELEASE loJsonToken
RELEASE loSbAuth
RELEASE loRest
RELEASE loSbJsonResponse
RELEASE loJson