Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3,4,5...TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

Visual Basic 6.0 Web API Examples

Primary Categories

ABN AMRO
AWS Translate
Activix CRM
Adyen
Amazon MWS
Azure Maps
Azure Monitor
Azure OAuth2
Azure Storage Accounts
Bluzone
CardConnect
ClickBank
Clickatell
Cloudfare
DocuSign
ETrade
Etsy
Facebook
GeoOp
GetHarvest
Global Payments
Google Search Console
Hungary NAV Invoicing
Jira
MYOB
Magento
MercadoLibre

Microsoft Calendar
Microsoft Group
Microsoft Tasks and Plans
Okta OAuth/OIDC
OneLogin OIDC
PayPal
Peoplevox
Populi
QuickBooks
Rabobank
SOAP finkok.com
Shippo
Shopify
Stripe
SugarCRM
Trello
Twilio
Twitter
VoiceBase
Vonage
Walmart
Walmart v3
WhatsApp
WooCommerce
Xero
Yousign
_Miscellaneous_
eBay
effectconnect

 

 

 

(Visual Basic 6.0) PayPal Search for Invoices

Search PayPal invoices.

See also SearchInvoices

Chilkat ActiveX Downloads

ActiveX for 32-bit and 64-bit Windows

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

' Build the Authorization request header field value.
Dim sbAuth As New ChilkatStringBuilder
' 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 ChilkatRest
Dim bAutoReconnect As Long
bAutoReconnect = 1
Dim success As Long
success = rest.Connect("api.sandbox.paypal.com",443,1,bAutoReconnect)
If (success <> 1) 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..
' ----------------------------------------------------------------------------------------------

' Create JSON to specify the search
Dim json As New ChilkatJsonObject
json.EmitCompact = 0
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",1)

Debug.Print 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 = 1
Dim sbRequestBody As New ChilkatStringBuilder
Dim sbResponseBody As New ChilkatStringBuilder

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 <> 1) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

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

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

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

' Sample response JSON is shown below.

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

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

 

© 2000-2020 Chilkat Software, Inc. All Rights Reserved.