Pascal (Lazarus/Delphi)

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.

Pascal (Lazarus/Delphi)

program ChilkatDemo;

// Demonstrates using the Chilkat Pascal wrapper via the C bridge DLL.
// Builds as a console application under Lazarus (FPC) or Delphi.

{$IFDEF FPC}
  {$MODE DELPHI}
{$ENDIF}
{$APPTYPE CONSOLE}

uses
  {$IFDEF UNIX}
  cthreads,
  {$ENDIF}
  SysUtils,
  CkDllLoader,
  Chilkat.StringBuilder,
  Chilkat.Rest,
  Chilkat.JsonObject;

// ---------------------------------------------------------------------------

procedure RunDemo;
var
  success: Boolean;
  jsonToken: TJsonObject;
  sbAuth: TStringBuilder;
  rest: TRest;
  bAutoReconnect: Boolean;
  invoiceId: string;
  sbPath: TStringBuilder;
  sbJsonResponse: TStringBuilder;

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

  //  Build the Authorization request header field value.
  sbAuth := TStringBuilder.Create;
  //  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 := TRest.Create;
  bAutoReconnect := True;
  success := rest.Connect('api.sandbox.paypal.com',443,True,bAutoReconnect);
  if (success <> True) then
    begin
      WriteLn(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 := TStringBuilder.Create;
  sbPath.Append('/v1/invoicing/invoices/');
  sbPath.Append(invoiceId);

  //  Send the DELETE request and get the JSON response.
  sbJsonResponse := TStringBuilder.Create;
  success := rest.FullRequestNoBodySb('DELETE',sbPath.GetAsString(),sbJsonResponse);
  if (success <> True) then
    begin
      WriteLn(rest.LastErrorText);
      Exit;
    end;

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

  //  Did we get a 204 success response?
  if (rest.ResponseStatusCode <> 204) then
    begin
      WriteLn('Failed.');
      Exit;
    end;

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


  jsonToken.Free;
  sbAuth.Free;
  rest.Free;
  sbPath.Free;
  sbJsonResponse.Free;

end;

// ---------------------------------------------------------------------------

begin

  try
    RunDemo;
  except
    on E: Exception do
      WriteLn('Unhandled exception: ', E.ClassName, ': ', E.Message);
  end;

  WriteLn;
  {$IFDEF MSWINDOWS}
  WriteLn('Press Enter to exit...');
  ReadLn;
  {$ENDIF}
end.