Delphi ActiveX

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 ActiveX

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

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Integer;
jsonToken: TChilkatJsonObject;
sbAuth: TChilkatStringBuilder;
rest: TChilkatRest;
bAutoReconnect: Integer;
invoiceId: WideString;
sbPath: TChilkatStringBuilder;
sbJsonResponse: TChilkatStringBuilder;

begin
success := 0;

// 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 := TChilkatJsonObject.Create(Self);
jsonToken.LoadFile('qa_data/tokens/paypal.json');

// Build the Authorization request header field value.
sbAuth := TChilkatStringBuilder.Create(Self);
// token_type should be "Bearer"
sbAuth.Append(jsonToken.StringOf('token_type'));
sbAuth.Append(' ');
sbAuth.Append(jsonToken.StringOf('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 := TChilkatRest.Create(Self);
bAutoReconnect := 1;
success := rest.Connect('api.sandbox.paypal.com',443,1,bAutoReconnect);
if (success <> 1) then
  begin
    Memo1.Lines.Add(rest.LastErrorText);
    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..
// ----------------------------------------------------------------------------------------------

rest.AddHeader('Authorization',sbAuth.GetAsString());

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

sbPath := TChilkatStringBuilder.Create(Self);
sbPath.Append('/v1/invoicing/invoices/');
sbPath.Append(invoiceId);

// Send the DELETE request and get the JSON response.
sbJsonResponse := TChilkatStringBuilder.Create(Self);
success := rest.FullRequestNoBodySb('DELETE',sbPath.GetAsString(),sbJsonResponse.ControlInterface);
if (success <> 1) then
  begin
    Memo1.Lines.Add(rest.LastErrorText);
    Exit;
  end;

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

// Did we get a 204 success response?
if (rest.ResponseStatusCode <> 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.');
end;