(PHP Extension) PayPal - Delete Draft Invoice

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.

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

// 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 = new CkJsonObject();
$jsonToken->LoadFile('qa_data/tokens/paypal.json');

// Build the Authorization request header field value.
$sbAuth = new CkStringBuilder();
// 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 = new CkRest();
$bAutoReconnect = true;
$success = $rest->Connect('api.sandbox.paypal.com',443,true,$bAutoReconnect);
if ($success != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

// ----------------------------------------------------------------------------------------------
// 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 = new CkStringBuilder();
$sbPath->Append('/v1/invoicing/invoices/');
$sbPath->Append($invoiceId);

// Send the DELETE request and get the JSON response.
$sbJsonResponse = new CkStringBuilder();
$success = $rest->FullRequestNoBodySb('DELETE',$sbPath->getAsString(),$sbJsonResponse);
if ($success != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

// A 204 response is expected for success.
print 'Response Status Code = ' . $rest->get_ResponseStatusCode() . "\n";

// Did we get a 204 success response?
if ($rest->get_ResponseStatusCode() != 204) {
    print 'Failed.' . "\n";
    exit;
}

print 'Received successful 204 status code response.' . "\n";
print 'There is no response body, as expected.' . "\n";
print 'Success.' . "\n";

?>