(Delphi DLL) PayPal List Merchant Invoices

List PayPal invoices.

Chilkat for Delphi Downloads

Chilkat non-ActiveX DLL for Delphi

Chilkat ActiveX DLL for Delphi

* The examples here use the non-ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, StringBuilder, Rest, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
jsonToken: HCkJsonObject;
sbAuth: HCkStringBuilder;
rest: HCkRest;
bAutoReconnect: Boolean;
success: Boolean;
sbJsonResponse: HCkStringBuilder;
json: HCkJsonObject;
numInvoices: Integer;
i: Integer;
j: Integer;
numBillingInfo: Integer;
numLinks: Integer;

begin
// 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)
jsonToken := CkJsonObject_Create();
CkJsonObject_LoadFile(jsonToken,'qa_data/tokens/paypal.json');

// Build the Authorization request header field value.
sbAuth := CkStringBuilder_Create();
// token_type should be "Bearer"
CkStringBuilder_Append(sbAuth,CkJsonObject__stringOf(jsonToken,'token_type'));
CkStringBuilder_Append(sbAuth,' ');
CkStringBuilder_Append(sbAuth,CkJsonObject__stringOf(jsonToken,'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.
rest := CkRest_Create();
bAutoReconnect := True;
success := CkRest_Connect(rest,'api.sandbox.paypal.com',443,True,bAutoReconnect);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

// ----------------------------------------------------------------------------------------------
// 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..
// ----------------------------------------------------------------------------------------------

CkRest_AddHeader(rest,'Authorization',CkStringBuilder__getAsString(sbAuth));
CkRest_AddQueryParam(rest,'page','0');
CkRest_AddQueryParam(rest,'page_size','20');
CkRest_AddQueryParam(rest,'total_count_required','true');

// Send the GET request and get the JSON response.
sbJsonResponse := CkStringBuilder_Create();
success := CkRest_FullRequestNoBodySb(rest,'GET','/v1/invoicing/invoices',sbJsonResponse);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

json := CkJsonObject_Create();
CkJsonObject_putEmitCompact(json,False);
CkJsonObject_LoadSb(json,sbJsonResponse);

Memo1.Lines.Add('Response Status Code = ' + IntToStr(CkRest_getResponseStatusCode(rest)));

// Did we get a 200 success response?
if (CkRest_getResponseStatusCode(rest) <> 200) then
  begin
    Memo1.Lines.Add(CkJsonObject__emit(json));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// Sample response JSON is shown below.

// Iterate over each invoice and get some information from each..
numInvoices := CkJsonObject_SizeOfArray(json,'invoices');
i := 0;
while i < numInvoices do
  begin
    CkJsonObject_putI(json,i);
    Memo1.Lines.Add('Invoice ID: ' + CkJsonObject__stringOf(json,'invoices[i].id'));
    Memo1.Lines.Add('Invoice Number: ' + CkJsonObject__stringOf(json,'invoices[i].number'));
    Memo1.Lines.Add('Invoice Status: ' + CkJsonObject__stringOf(json,'invoices[i].status'));
    Memo1.Lines.Add('Shipping First Name: ' + CkJsonObject__stringOf(json,'invoices[i].shipping_info.first_name'));
    j := 0;
    numBillingInfo := CkJsonObject_SizeOfArray(json,'invoices[i].billing_info');
    while j < numBillingInfo do
      begin
        CkJsonObject_putJ(json,j);
        Memo1.Lines.Add('billing_info email: ' + CkJsonObject__stringOf(json,'invoices[i].billing_info[j].email'));
        j := j + 1;
      end;

    numLinks := CkJsonObject_SizeOfArray(json,'invoices[i].links');
    j := 0;
    while j < numLinks do
      begin
        CkJsonObject_putJ(json,j);
        Memo1.Lines.Add('link: ' + CkJsonObject__stringOf(json,'invoices[i].links[j].href'));
        j := j + 1;
      end;

    Memo1.Lines.Add('----');
    i := i + 1;
  end;

Memo1.Lines.Add('Success.');

// 	{ 
// 	  "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"
// 	    }
// 	  ]
// 	}
// 

CkJsonObject_Dispose(jsonToken);
CkStringBuilder_Dispose(sbAuth);
CkRest_Dispose(rest);
CkStringBuilder_Dispose(sbJsonResponse);
CkJsonObject_Dispose(json);

end;