(Xojo Plugin) PayPal Search for Invoices

Search PayPal invoices.

See also SearchInvoices

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

// 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 New Chilkat.JsonObject
success = jsonToken.LoadFile("qa_data/tokens/paypal.json")

// Build the Authorization request header field value.
Dim sbAuth As New Chilkat.StringBuilder
// 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 New Chilkat.Rest
Dim bAutoReconnect As Boolean
bAutoReconnect = True
Dim success As Boolean
success = rest.Connect("api.sandbox.paypal.com",443,True,bAutoReconnect)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
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..
// ----------------------------------------------------------------------------------------------

// Create JSON to specify the search
Dim json As New Chilkat.JsonObject
json.EmitCompact = False
success = json.AppendString("start_invoice_date","2016-01-01 PST")
success = json.AppendString("end_invoice_date","2016-11-16 PST")
success = json.AppendInt("page",0)
success = json.AppendInt("page_size",10)
success = json.AppendBool("total_count_required",True)

System.DebugLog(json.Emit())

// The JSON by the above code:

// 	{
// 	  "start_invoice_date": "2016-01-01 PST",
// 	  "end_invoice_date": "2016-11-16 PST",
// 	  "page": 0,
// 	  "page_size": 10,
// 	  "total_count_required": true
// 	}

// Send the POST equivalent to this CURL command:

// 	curl -v -X POST https://api.sandbox.paypal.com/v1/invoicing/search/ \
// 	-H "Content-Type:application/json" \
// 	-H "Authorization: Bearer Access-Token" \
// 	-d '{ invoice JSON goes here }'

json.EmitCompact = True
Dim sbRequestBody As New Chilkat.StringBuilder
Dim sbResponseBody As New Chilkat.StringBuilder

success = rest.AddHeader("Content-Type","application/json")
success = rest.AddHeader("Authorization",sbAuth.GetAsString())
success = json.EmitSb(sbRequestBody)

success = rest.FullRequestSb("POST","/v1/invoicing/search",sbRequestBody,sbResponseBody)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

// We should have some sort of JSON response.  It could be successful, or an error.
Dim jsonResponse As New Chilkat.JsonObject
jsonResponse.EmitCompact = False
success = jsonResponse.LoadSb(sbResponseBody)

System.DebugLog("Response Status Code = " + Str(rest.ResponseStatusCode))

// Did we get a 200 success response?
If (rest.ResponseStatusCode <> 200) Then
    // Show the JSON response body
    System.DebugLog(jsonResponse.Emit())
    System.DebugLog("Failed.")
    Return
End If

// Sample response JSON is shown below.

// Iterate over each invoice and get some information from each..
Dim numInvoices As Int32
numInvoices = jsonResponse.SizeOfArray("invoices")
Dim i As Int32
i = 0
While i < numInvoices
    jsonResponse.I = i
    System.DebugLog("Invoice ID: " + jsonResponse.StringOf("invoices[i].id"))
    System.DebugLog("Shipping First Name: " + jsonResponse.StringOf("invoices[i].shipping_info.first_name"))
    Dim j As Int32
    j = 0
    Dim numBillingInfo As Int32
    numBillingInfo = jsonResponse.SizeOfArray("invoices[i].billing_info")
    While j < numBillingInfo
        jsonResponse.J = j
        System.DebugLog("billing_info email: " + jsonResponse.StringOf("invoices[i].billing_info[j].email"))
        j = j + 1
    Wend
    Dim numLinks As Int32
    numLinks = jsonResponse.SizeOfArray("invoices[i].links")
    j = 0
    While j < numLinks
        jsonResponse.J = j
        System.DebugLog("link: " + jsonResponse.StringOf("invoices[i].links[j].href"))
        j = j + 1
    Wend
    System.DebugLog("----")
    i = i + 1
Wend

System.DebugLog("Success.")

// A successful response looks like this:

// { 
//   "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"
//         }
//       ]
//     }
//   ]
// }
//