Visual FoxPro
Visual FoxPro
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
Chilkat Visual FoxPro Downloads
LOCAL lnSuccess
LOCAL loJsonToken
LOCAL loSbAuth
LOCAL loRest
LOCAL lnBAutoReconnect
LOCAL lcInvoiceId
LOCAL loSbPath
LOCAL loSbJsonResponse
LOCAL loJson
LOCAL lnNumItems
LOCAL i
lnSuccess = 0
* 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)
loJsonToken = CreateObject('Chilkat.JsonObject')
loJsonToken.LoadFile("qa_data/tokens/paypal.json")
* Build the Authorization request header field value.
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.
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())
lcInvoiceId = "INV2-XV4B-736P-PLVN-SZCE"
loSbPath = CreateObject('Chilkat.StringBuilder')
loSbPath.Append("/v1/invoicing/invoices/")
loSbPath.Append(lcInvoiceId)
* Send the GET request and get the JSON response.
loSbJsonResponse = CreateObject('Chilkat.StringBuilder')
lnSuccess = loRest.FullRequestNoBodySb("GET",loSbPath.GetAsString(),loSbJsonResponse)
IF (lnSuccess <> 1) THEN
? loRest.LastErrorText
RELEASE loJsonToken
RELEASE loSbAuth
RELEASE loRest
RELEASE loSbPath
RELEASE loSbJsonResponse
CANCEL
ENDIF
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 loSbPath
RELEASE loSbJsonResponse
RELEASE loJson
CANCEL
ENDIF
* Sample response JSON is shown below.
* Get some information..
? "email: " + loJson.StringOf("merchant_info.email")
? "business_name: " + loJson.StringOf("merchant_info.business_name")
lnNumItems = loJson.SizeOfArray("items")
i = 0
DO WHILE i < lnNumItems
loJson.I = i
? "item name: " + loJson.StringOf("items[i].name")
? "item quantity: " + loJson.StringOf("items[i].quantity")
? "item currency: " + loJson.StringOf("items[i].unit_price.currency")
? "item value: " + loJson.StringOf("items[i].unit_price.value")
? "----"
i = i + 1
ENDDO
? "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"
* }
* ]
* }
*
RELEASE loJsonToken
RELEASE loSbAuth
RELEASE loRest
RELEASE loSbPath
RELEASE loSbJsonResponse
RELEASE loJson