Sample code for 30+ languages & platforms
Xojo Plugin Requires Chilkat v11.0.0+

PayPal: Build a worklist of overdue invoices

See more PayPal Examples

Find open invoices due in the past 90 days, including partial payments. Walk all result pages and display the invoice number, due date, and remaining balance for the collections team.

PayPal documentation

Chilkat Xojo Plugin Downloads

Xojo Plugin
Dim success As Boolean
success = False

//  See Unlock Chilkat before making requests.
//  For the merchant's internal backoffice application. Load the sandbox token
//  from the merchant's credential store. Keep it out of publicly distributed apps.
//  See Get a PayPal access token.
Dim http As New Chilkat.Http
http.AuthToken = "SANDBOX_ACCESS_TOKEN"
Dim resp As New Chilkat.HttpResponse
Dim body As New Chilkat.JsonObject
success = body.UpdateString("status[0]","SENT")
success = body.UpdateString("status[1]","PARTIALLY_PAID")
success = body.UpdateString("status[2]","UNPAID")
success = body.UpdateString("status[3]","SHARED")
//  Yesterday is the last overdue date. Include invoices due in the past 90 days.
Dim day As New Chilkat.CkDateTime
success = day.SetFromCurrentSystemTime()
success = day.AddDays(-1)
success = body.UpdateString("due_date_range.end",day.GetAsIso8601("YYYY-MM-DD",False))
success = day.AddDays(-89)
success = body.UpdateString("due_date_range.start",day.GetAsIso8601("YYYY-MM-DD",False))
Dim page As Int32
page = 1
Dim lastPage As Int32
lastPage = 1
While (page <= lastPage)
    Dim url As New Chilkat.StringBuilder
    success = url.Append("https://api-m.sandbox.paypal.com/v2/invoicing/search-invoices?total_required=true&page_size=50&page=")
    success = url.AppendInt(page)
    success = http.HttpJson("POST",url.GetAsString(),body,"application/json",resp)
    If (success <> True) Then
        System.DebugLog("No HTTP response: " + http.LastErrorText)
        Return
    End If

    If ((resp.StatusCode < 200) Or (resp.StatusCode >= 300)) Then
        Dim errorInfo As New Chilkat.JsonObject
        success = errorInfo.Load(resp.BodyStr)
        System.DebugLog("HTTP " + Str(resp.StatusCode) + " " + errorInfo.StringOf("name") + " " + errorInfo.StringOf("details[0].issue"))
        System.DebugLog("PayPal debug ID: " + errorInfo.StringOf("debug_id"))
        Return
    End If

    Dim result As New Chilkat.JsonObject
    Dim parsedResult As Boolean
    parsedResult = result.Load(resp.BodyStr)
    If (parsedResult <> True) Then
        System.DebugLog("Expected a JSON response; HTTP " + Str(resp.StatusCode))
        Return
    End If

    Dim i As Int32
    i = 0
    Dim count As Int32
    count = result.SizeOfArray("items")
    While (i < count)
        result.I = i
        System.DebugLog(result.StringOf("items[i].detail.invoice_number") + "  due " + result.StringOf("items[i].detail.payment_term.due_date") + "  " + result.StringOf("items[i].due_amount.value") _
             + " " + result.StringOf("items[i].due_amount.currency_code"))
        i = i + 1
    Wend
    lastPage = result.IntOf("total_pages")
    page = page + 1
Wend