Sample code for 30+ languages & platforms
JavaScript 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

Note
This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.
JavaScript
var 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.
var http = new CkHttp();
http.AuthToken = "SANDBOX_ACCESS_TOKEN";
var resp = new CkHttpResponse();
var body = new CkJsonObject();
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.
var day = new 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));
var page = 1;
var lastPage = 1;
while ((page <= lastPage)) {
    var url = new CkStringBuilder();
    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) {
        console.log("No HTTP response: " + http.LastErrorText);
        return;
    }

    if ((resp.StatusCode < 200) || (resp.StatusCode >= 300)) {
        var errorInfo = new CkJsonObject();
        errorInfo.Load(resp.BodyStr);
        console.log("HTTP " + resp.StatusCode + " " + errorInfo.StringOf("name") + " " + errorInfo.StringOf("details[0].issue"));
        console.log("PayPal debug ID: " + errorInfo.StringOf("debug_id"));
        return;
    }

    var result = new CkJsonObject();
    var parsedResult = result.Load(resp.BodyStr);
    if (parsedResult !== true) {
        console.log("Expected a JSON response; HTTP " + resp.StatusCode);
        return;
    }

    var i = 0;
    var count = result.SizeOfArray("items");
    while ((i < count)) {
        result.I = i;
        console.log(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;
}