PowerBuilder
PowerBuilder
PayPal Search for Invoices
See more PayPal Examples
Search PayPal invoices.See also SearchInvoices
Chilkat PowerBuilder Downloads
integer li_rc
long li_Success
oleobject loo_JsonToken
oleobject loo_SbAuth
oleobject loo_Rest
long li_BAutoReconnect
oleobject loo_Json
oleobject loo_SbRequestBody
oleobject loo_SbResponseBody
oleobject loo_JsonResponse
long li_NumInvoices
long i
long j
long li_NumBillingInfo
long li_NumLinks
li_Success = 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)
loo_JsonToken = create oleobject
li_rc = loo_JsonToken.ConnectToNewObject("Chilkat.JsonObject")
if li_rc < 0 then
destroy loo_JsonToken
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_JsonToken.LoadFile("qa_data/tokens/paypal.json")
// Build the Authorization request header field value.
loo_SbAuth = create oleobject
li_rc = loo_SbAuth.ConnectToNewObject("Chilkat.StringBuilder")
// token_type should be "Bearer"
loo_SbAuth.Append(loo_JsonToken.StringOf("token_type"))
loo_SbAuth.Append(" ")
loo_SbAuth.Append(loo_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.
loo_Rest = create oleobject
li_rc = loo_Rest.ConnectToNewObject("Chilkat.Rest")
li_BAutoReconnect = 1
li_Success = loo_Rest.Connect("api.sandbox.paypal.com",443,1,li_BAutoReconnect)
if li_Success <> 1 then
Write-Debug loo_Rest.LastErrorText
destroy loo_JsonToken
destroy loo_SbAuth
destroy loo_Rest
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
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")
loo_Json.EmitCompact = 0
loo_Json.AppendString("start_invoice_date","2016-01-01 PST")
loo_Json.AppendString("end_invoice_date","2016-11-16 PST")
loo_Json.AppendInt("page",0)
loo_Json.AppendInt("page_size",10)
loo_Json.AppendBool("total_count_required",1)
Write-Debug loo_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 }'
loo_Json.EmitCompact = 1
loo_SbRequestBody = create oleobject
li_rc = loo_SbRequestBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Rest.AddHeader("Content-Type","application/json")
loo_Rest.AddHeader("Authorization",loo_SbAuth.GetAsString())
loo_Json.EmitSb(loo_SbRequestBody)
li_Success = loo_Rest.FullRequestSb("POST","/v1/invoicing/search",loo_SbRequestBody,loo_SbResponseBody)
if li_Success <> 1 then
Write-Debug loo_Rest.LastErrorText
destroy loo_JsonToken
destroy loo_SbAuth
destroy loo_Rest
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_SbResponseBody
return
end if
// We should have some sort of JSON response. It could be successful, or an error.
loo_JsonResponse = create oleobject
li_rc = loo_JsonResponse.ConnectToNewObject("Chilkat.JsonObject")
loo_JsonResponse.EmitCompact = 0
loo_JsonResponse.LoadSb(loo_SbResponseBody)
Write-Debug "Response Status Code = " + string(loo_Rest.ResponseStatusCode)
// Did we get a 200 success response?
if loo_Rest.ResponseStatusCode <> 200 then
// Show the JSON response body
Write-Debug loo_JsonResponse.Emit()
Write-Debug "Failed."
destroy loo_JsonToken
destroy loo_SbAuth
destroy loo_Rest
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_SbResponseBody
destroy loo_JsonResponse
return
end if
// Sample response JSON is shown below.
// Iterate over each invoice and get some information from each..
li_NumInvoices = loo_JsonResponse.SizeOfArray("invoices")
i = 0
do while i < li_NumInvoices
loo_JsonResponse.I = i
Write-Debug "Invoice ID: " + loo_JsonResponse.StringOf("invoices[i].id")
Write-Debug "Shipping First Name: " + loo_JsonResponse.StringOf("invoices[i].shipping_info.first_name")
j = 0
li_NumBillingInfo = loo_JsonResponse.SizeOfArray("invoices[i].billing_info")
do while j < li_NumBillingInfo
loo_JsonResponse.J = j
Write-Debug "billing_info email: " + loo_JsonResponse.StringOf("invoices[i].billing_info[j].email")
j = j + 1
loop
li_NumLinks = loo_JsonResponse.SizeOfArray("invoices[i].links")
j = 0
do while j < li_NumLinks
loo_JsonResponse.J = j
Write-Debug "link: " + loo_JsonResponse.StringOf("invoices[i].links[j].href")
j = j + 1
loop
Write-Debug "----"
i = i + 1
loop
Write-Debug "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"
// }
// ]
// }
// ]
// }
//
destroy loo_JsonToken
destroy loo_SbAuth
destroy loo_Rest
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_SbResponseBody
destroy loo_JsonResponse