Delphi DLL

PayPal - Delete Draft Invoice

See more PayPal Examples

Deletes a draft invoice, by ID. Note that this call works for invoices in the draft state only. For invoices that have already been sent, you can cancel the invoice.

Note: This example requires Chilkat v9.5.0.65 or greater.

Delphi 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
success: Boolean;
jsonToken: HCkJsonObject;
sbAuth: HCkStringBuilder;
rest: HCkRest;
bAutoReconnect: Boolean;
invoiceId: PWideChar;
sbPath: HCkStringBuilder;
sbJsonResponse: HCkStringBuilder;

begin
success := False;

// Note: Requires Chilkat v9.5.0.65 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));

invoiceId := 'INV2-29Z4-EB7M-MUCY-327J';

sbPath := CkStringBuilder_Create();
CkStringBuilder_Append(sbPath,'/v1/invoicing/invoices/');
CkStringBuilder_Append(sbPath,invoiceId);

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

// A 204 response is expected for success.
Memo1.Lines.Add('Response Status Code = ' + IntToStr(CkRest_getResponseStatusCode(rest)));

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

Memo1.Lines.Add('Received successful 204 status code response.');
Memo1.Lines.Add('There is no response body, as expected.');
Memo1.Lines.Add('Success.');

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

end;