Dart

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.

Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // 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)
  final jsonToken = CkJsonObject();
  jsonToken.loadFile('qa_data/tokens/paypal.json');

  // Build the Authorization request header field value.
  final sbAuth = 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.
  final rest = CkRest();
  final bAutoReconnect = true;
  try {
    rest.connect('api.sandbox.paypal.com', 443, true, bAutoReconnect);
  } on ChilkatException catch (e) {
    print(e.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());

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

  final sbPath = CkStringBuilder();
  sbPath.append('/v1/invoicing/invoices/');
  sbPath.append(invoiceId);

  // Send the DELETE request and get the JSON response.
  final sbJsonResponse = CkStringBuilder();
  try {
    rest.fullRequestNoBodySb('DELETE', sbPath.getAsString(), sbJsonResponse);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // A 204 response is expected for success.
  print('Response Status Code = ${rest.responseStatusCode}');

  // Did we get a 204 success response?
  if (rest.responseStatusCode != 204) {
    print('Failed.');
    return;
  }

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