(AutoIt) PayPal List Merchant Invoices

List PayPal invoices.

See also PayPal List Invoices REST API Reference

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)
$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
Local $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..
; ----------------------------------------------------------------------------------------------

$oRest.AddHeader("Authorization",$oSbAuth.GetAsString())
$oRest.AddQueryParam("page","0")
$oRest.AddQueryParam("page_size","20")
$oRest.AddQueryParam("total_count_required","true")

; Send the GET request and get the JSON response.
$oSbJsonResponse = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oRest.FullRequestNoBodySb("GET","/v1/invoicing/invoices",$oSbJsonResponse)
If ($bSuccess <> True) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.EmitCompact = False
$oJson.LoadSb($oSbJsonResponse)

ConsoleWrite("Response Status Code = " & $oRest.ResponseStatusCode & @CRLF)

; Did we get a 200 success response?
If ($oRest.ResponseStatusCode <> 200) Then
    ConsoleWrite($oJson.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 = $oJson.SizeOfArray("invoices")
Local $i = 0
While $i < $iNumInvoices
    $oJson.I = $i
    ConsoleWrite("Invoice ID: " & $oJson.StringOf("invoices[i].id") & @CRLF)
    ConsoleWrite("Invoice Number: " & $oJson.StringOf("invoices[i].number") & @CRLF)
    ConsoleWrite("Invoice Status: " & $oJson.StringOf("invoices[i].status") & @CRLF)
    ConsoleWrite("Shipping First Name: " & $oJson.StringOf("invoices[i].shipping_info.first_name") & @CRLF)
Local $iJ = 0
Local $iNumBillingInfo = $oJson.SizeOfArray("invoices[i].billing_info")
    While $iJ < $iNumBillingInfo
        $oJson.J = $iJ
        ConsoleWrite("billing_info email: " & $oJson.StringOf("invoices[i].billing_info[j].email") & @CRLF)
        $iJ = $iJ + 1
    Wend
Local $iNumLinks = $oJson.SizeOfArray("invoices[i].links")
    $iJ = 0
    While $iJ < $iNumLinks
        $oJson.J = $iJ
        ConsoleWrite("link: " & $oJson.StringOf("invoices[i].links[j].href") & @CRLF)
        $iJ = $iJ + 1
    Wend
    ConsoleWrite("----" & @CRLF)
    $i = $i + 1
Wend

ConsoleWrite("Success." & @CRLF)

; 	{ 
; 	  "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"
; 	        }
; 	      ]
; 	    }
; 	  ],
; 	  "links": [
; 	    { 
; 	      "rel": "self",
; 	      "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices?page=0&page_size=20&total_count_required=true",
; 	      "method": "GET"
; 	    }
; 	  ]
; 	}
;