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

PureBasic
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkDateTime.pb"

Procedure ChilkatExample()

    success.i = 0

    ;  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.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttp::setCkAuthToken(http, "SANDBOX_ACCESS_TOKEN")
    resp.i = CkHttpResponse::ckCreate()
    If resp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    body.i = CkJsonObject::ckCreate()
    If body.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(body,"status[0]","SENT")
    CkJsonObject::ckUpdateString(body,"status[1]","PARTIALLY_PAID")
    CkJsonObject::ckUpdateString(body,"status[2]","UNPAID")
    CkJsonObject::ckUpdateString(body,"status[3]","SHARED")
    ;  Yesterday is the last overdue date. Include invoices due in the past 90 days.
    day.i = CkDateTime::ckCreate()
    If day.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkDateTime::ckSetFromCurrentSystemTime(day)
    CkDateTime::ckAddDays(day,-1)
    CkJsonObject::ckUpdateString(body,"due_date_range.end",CkDateTime::ckGetAsIso8601(day,"YYYY-MM-DD",0))
    CkDateTime::ckAddDays(day,-89)
    CkJsonObject::ckUpdateString(body,"due_date_range.start",CkDateTime::ckGetAsIso8601(day,"YYYY-MM-DD",0))
    page.i = 1
    lastPage.i = 1
    While (page <= lastPage)
        url.i = CkStringBuilder::ckCreate()
        If url.i = 0
            Debug "Failed to create object."
            ProcedureReturn
        EndIf

        CkStringBuilder::ckAppend(url,"https://api-m.sandbox.paypal.com/v2/invoicing/search-invoices?total_required=true&page_size=50&page=")
        CkStringBuilder::ckAppendInt(url,page)
        success = CkHttp::ckHttpJson(http,"POST",CkStringBuilder::ckGetAsString(url),body,"application/json",resp)
        If success <> 1
            Debug "No HTTP response: " + CkHttp::ckLastErrorText(http)
            CkHttp::ckDispose(http)
            CkHttpResponse::ckDispose(resp)
            CkJsonObject::ckDispose(body)
            CkDateTime::ckDispose(day)
            CkStringBuilder::ckDispose(url)
            ProcedureReturn
        EndIf

        If (CkHttpResponse::ckStatusCode(resp) < 200) OR (CkHttpResponse::ckStatusCode(resp) >= 300)
            errorInfo.i = CkJsonObject::ckCreate()
            If errorInfo.i = 0
                Debug "Failed to create object."
                ProcedureReturn
            EndIf

            CkJsonObject::ckLoad(errorInfo,CkHttpResponse::ckBodyStr(resp))
            Debug "HTTP " + Str(CkHttpResponse::ckStatusCode(resp)) + " " + CkJsonObject::ckStringOf(errorInfo,"name") + " " + CkJsonObject::ckStringOf(errorInfo,"details[0].issue")
            Debug "PayPal debug ID: " + CkJsonObject::ckStringOf(errorInfo,"debug_id")
            CkHttp::ckDispose(http)
            CkHttpResponse::ckDispose(resp)
            CkJsonObject::ckDispose(body)
            CkDateTime::ckDispose(day)
            CkStringBuilder::ckDispose(url)
            CkJsonObject::ckDispose(errorInfo)
            ProcedureReturn
        EndIf

        result.i = CkJsonObject::ckCreate()
        If result.i = 0
            Debug "Failed to create object."
            ProcedureReturn
        EndIf

        parsedResult.i = CkJsonObject::ckLoad(result,CkHttpResponse::ckBodyStr(resp))
        If parsedResult <> 1
            Debug "Expected a JSON response; HTTP " + Str(CkHttpResponse::ckStatusCode(resp))
            CkHttp::ckDispose(http)
            CkHttpResponse::ckDispose(resp)
            CkJsonObject::ckDispose(body)
            CkDateTime::ckDispose(day)
            CkStringBuilder::ckDispose(url)
            CkJsonObject::ckDispose(errorInfo)
            CkJsonObject::ckDispose(result)
            ProcedureReturn
        EndIf

        i.i = 0
        count.i = CkJsonObject::ckSizeOfArray(result,"items")
        While (i < count)
            CkJsonObject::setCkI(result, i)
            Debug CkJsonObject::ckStringOf(result,"items[i].detail.invoice_number") + "  due " + CkJsonObject::ckStringOf(result,"items[i].detail.payment_term.due_date") + "  " + CkJsonObject::ckStringOf(result,"items[i].due_amount.value") + " " + CkJsonObject::ckStringOf(result,"items[i].due_amount.currency_code")
            i = i + 1
        Wend
        lastPage = CkJsonObject::ckIntOf(result,"total_pages")
        page = page + 1
    Wend


    CkHttp::ckDispose(http)
    CkHttpResponse::ckDispose(resp)
    CkJsonObject::ckDispose(body)
    CkDateTime::ckDispose(day)
    CkStringBuilder::ckDispose(url)
    CkJsonObject::ckDispose(errorInfo)
    CkJsonObject::ckDispose(result)


    ProcedureReturn
EndProcedure