C#

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.

C#

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

// Build the Authorization request header field value.
Chilkat.StringBuilder sbAuth = new 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.
Chilkat.Rest rest = new Chilkat.Rest();
bool bAutoReconnect = true;
success = rest.Connect("api.sandbox.paypal.com",443,true,bAutoReconnect);
if (success != true) {
    Debug.WriteLine(rest.LastErrorText);
    return;
}

// ----------------------------------------------------------------------------------------------
// 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());

string invoiceId = "INV2-29Z4-EB7M-MUCY-327J";

Chilkat.StringBuilder sbPath = new Chilkat.StringBuilder();
sbPath.Append("/v1/invoicing/invoices/");
sbPath.Append(invoiceId);

// Send the DELETE request and get the JSON response.
Chilkat.StringBuilder sbJsonResponse = new Chilkat.StringBuilder();
success = rest.FullRequestNoBodySb("DELETE",sbPath.GetAsString(),sbJsonResponse);
if (success != true) {
    Debug.WriteLine(rest.LastErrorText);
    return;
}

// A 204 response is expected for success.
Debug.WriteLine("Response Status Code = " + Convert.ToString(rest.ResponseStatusCode));

// Did we get a 204 success response?
if (rest.ResponseStatusCode != 204) {
    Debug.WriteLine("Failed.");
    return;
}

Debug.WriteLine("Received successful 204 status code response.");
Debug.WriteLine("There is no response body, as expected.");
Debug.WriteLine("Success.");