Python 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

Python

import sys
import chilkat2

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.
http = chilkat2.Http()
http.AuthToken = "SANDBOX_ACCESS_TOKEN"
resp = chilkat2.HttpResponse()
body = chilkat2.JsonObject()
body.UpdateString("status[0]","SENT")
body.UpdateString("status[1]","PARTIALLY_PAID")
body.UpdateString("status[2]","UNPAID")
body.UpdateString("status[3]","SHARED")
# Yesterday is the last overdue date. Include invoices due in the past 90 days.
day = chilkat2.CkDateTime()
day.SetFromCurrentSystemTime()
day.AddDays(-1)
body.UpdateString("due_date_range.end",day.GetAsIso8601("YYYY-MM-DD",False))
day.AddDays(-89)
body.UpdateString("due_date_range.start",day.GetAsIso8601("YYYY-MM-DD",False))
page = 1
lastPage = 1
while (page <= lastPage) :
    url = chilkat2.StringBuilder()
    url.Append("https://api-m.sandbox.paypal.com/v2/invoicing/search-invoices?total_required=true&page_size=50&page=")
    url.AppendInt(page)
    success = http.HttpJson("POST",url.GetAsString(),body,"application/json",resp)
    if (success != True):
        print("No HTTP response: " + http.LastErrorText)
        sys.exit()

    if ((resp.StatusCode < 200) or (resp.StatusCode >= 300)):
        errorInfo = chilkat2.JsonObject()
        errorInfo.Load(resp.BodyStr)
        print("HTTP " + str(resp.StatusCode) + " " + errorInfo.StringOf("name") + " " + errorInfo.StringOf("details[0].issue"))
        print("PayPal debug ID: " + errorInfo.StringOf("debug_id"))
        sys.exit()

    result = chilkat2.JsonObject()
    parsedResult = result.Load(resp.BodyStr)
    if (parsedResult != True):
        print("Expected a JSON response; HTTP " + str(resp.StatusCode))
        sys.exit()

    i = 0
    count = result.SizeOfArray("items")
    while (i < count) :
        result.I = i
        print(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

    lastPage = result.IntOf("total_pages")
    page = page + 1