AutoIt
AutoIt
PayPal Search for Invoices
See more PayPal Examples
Search PayPal invoices.See also SearchInvoices
Chilkat AutoIt Downloads
Local $bSuccess = False
; 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)
$oJsonToken = ObjCreate("Chilkat.JsonObject")
$oJsonToken.LoadFile("qa_data/tokens/paypal.json")
; Build the Authorization request header field value.
$oSbAuth = ObjCreate("Chilkat.StringBuilder")
; token_type should be "Bearer"
$oSbAuth.Append($oJsonToken.StringOf("token_type"))
$oSbAuth.Append(" ")
$oSbAuth.Append($oJsonToken.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.
$oRest = ObjCreate("Chilkat.Rest")
Local $bAutoReconnect = True
$bSuccess = $oRest.Connect("api.sandbox.paypal.com",443,True,$bAutoReconnect)
If ($bSuccess <> True) Then
ConsoleWrite($oRest.LastErrorText & @CRLF)
Exit
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..
; ----------------------------------------------------------------------------------------------
; Create JSON to specify the search
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.EmitCompact = False
$oJson.AppendString("start_invoice_date","2016-01-01 PST")
$oJson.AppendString("end_invoice_date","2016-11-16 PST")
$oJson.AppendInt("page",0)
$oJson.AppendInt("page_size",10)
$oJson.AppendBool("total_count_required",True)
ConsoleWrite($oJson.Emit() & @CRLF)
; 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 }'
$oJson.EmitCompact = True
$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oRest.AddHeader("Content-Type","application/json")
$oRest.AddHeader("Authorization",$oSbAuth.GetAsString())
$oJson.EmitSb($oSbRequestBody)
$bSuccess = $oRest.FullRequestSb("POST","/v1/invoicing/search",$oSbRequestBody,$oSbResponseBody)
If ($bSuccess <> True) Then
ConsoleWrite($oRest.LastErrorText & @CRLF)
Exit
EndIf
; We should have some sort of JSON response. It could be successful, or an error.
$oJsonResponse = ObjCreate("Chilkat.JsonObject")
$oJsonResponse.EmitCompact = False
$oJsonResponse.LoadSb($oSbResponseBody)
ConsoleWrite("Response Status Code = " & $oRest.ResponseStatusCode & @CRLF)
; Did we get a 200 success response?
If ($oRest.ResponseStatusCode <> 200) Then
; Show the JSON response body
ConsoleWrite($oJsonResponse.Emit() & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample response JSON is shown below.
; Iterate over each invoice and get some information from each..
Local $iNumInvoices = $oJsonResponse.SizeOfArray("invoices")
Local $i = 0
While $i < $iNumInvoices
$oJsonResponse.I = $i
ConsoleWrite("Invoice ID: " & $oJsonResponse.StringOf("invoices[i].id") & @CRLF)
ConsoleWrite("Shipping First Name: " & $oJsonResponse.StringOf("invoices[i].shipping_info.first_name") & @CRLF)
Local $iJ = 0
Local $iNumBillingInfo = $oJsonResponse.SizeOfArray("invoices[i].billing_info")
While $iJ < $iNumBillingInfo
$oJsonResponse.J = $iJ
ConsoleWrite("billing_info email: " & $oJsonResponse.StringOf("invoices[i].billing_info[j].email") & @CRLF)
$iJ = $iJ + 1
Wend
Local $iNumLinks = $oJsonResponse.SizeOfArray("invoices[i].links")
$iJ = 0
While $iJ < $iNumLinks
$oJsonResponse.J = $iJ
ConsoleWrite("link: " & $oJsonResponse.StringOf("invoices[i].links[j].href") & @CRLF)
$iJ = $iJ + 1
Wend
ConsoleWrite("----" & @CRLF)
$i = $i + 1
Wend
ConsoleWrite("Success." & @CRLF)
; 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"
; }
; ]
; }
; ]
; }
;