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

PHP ActiveX

<?php

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

// Build the Authorization request header field value.
$sbAuth = new COM("Chilkat.StringBuilder");
// 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 COM("Chilkat.Rest");
$bAutoReconnect = 1;
$success = $rest->Connect('api.sandbox.paypal.com',443,1,$bAutoReconnect);
if ($success != 1) {
    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 COM("Chilkat.StringBuilder");
$sbPath->Append('/v1/invoicing/invoices/');
$sbPath->Append($invoiceId);

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

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

// Did we get a 204 success response?
if ($rest->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";

?>