Dart

PayPal - Update Invoice

See more PayPal Examples

Update a PayPal invoice.

Note: This example requires Chilkat v9.5.0.65 or greater.

See also PayPal Update Invoice REST API Reference

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

  // First create the JSON with updated information:

  final json = CkJsonObject();
  json.emitCompact = false;
  json.updateString('merchant_info.email', 'smith-facilitator@chilkatsoft.com');
  json.updateString('merchant_info.first_name', 'Joe');
  json.updateString('merchant_info.last_name', 'Facilitator');
  json.updateString('merchant_info.business_name', 'Medical Professionals, LLC');
  json.updateString('merchant_info.phone.country_code', '001');
  json.updateString('merchant_info.phone.national_number', '5032141716');
  json.updateString('merchant_info.address.line1', '1234 Main St.');
  json.updateString('merchant_info.address.city', 'Portland');
  json.updateString('merchant_info.address.state', 'OR');
  json.updateString('merchant_info.address.postal_code', '97217');
  json.updateString('merchant_info.address.country_code', 'US');
  json.updateString('billing_info[0].email', 'smith-buyer@chilkatsoft.com');
  json.updateString('shipping_info.first_name', 'Sally');
  json.updateString('shipping_info.last_name', 'Patient');
  json.updateString('shipping_info.business_name', 'Not applicable');
  json.updateString('shipping_info.phone.country_code', '001');
  json.updateString('shipping_info.phone.national_number', '5039871234');
  json.updateString('shipping_info.address.line1', '1234 Broad St.');
  json.updateString('shipping_info.address.city', 'Portland');
  json.updateString('shipping_info.address.state', 'OR');
  json.updateString('shipping_info.address.postal_code', '97216');
  json.updateString('shipping_info.address.country_code', 'US');
  json.updateString('items[0].name', 'Sutures');
  // We are updating the quantity from 100.0 to 200.0
  // Note: The UpdateNumber method is added in v9.5.0.65
  json.updateNumber('items[0].quantity', '200.0');
  json.updateString('items[0].unit_price.currency', 'USD');
  json.updateString('items[0].unit_price.value', '5.00');
  json.updateString('payment_term.term_type', 'NET_45');
  json.updateString('payment_term.due_date', '2016-12-30 PST');
  json.updateString('note', 'Medical Invoice 16 Jul, 2013 PST');

  // The JSON created by the above code is this:

  // 	{ 
  // 	  "merchant_info": { 
  // 	    "email": "smith-facilitator@chilkatsoft.com",
  // 	    "first_name": "Joe",
  // 	    "last_name": "Facilitator",
  // 	    "business_name": "Medical Professionals, LLC",
  // 	    "phone": { 
  // 	      "country_code": "001",
  // 	      "national_number": "5032141716"
  // 	    },
  // 	    "address": { 
  // 	      "line1": "1234 Main St.",
  // 	      "city": "Portland",
  // 	      "state": "OR",
  // 	      "postal_code": "97217",
  // 	      "country_code": "US"
  // 	    }
  // 	  },
  // 	  "billing_info": [
  // 	    { 
  // 	      "email": "smith-buyer@chilkatsoft.com"
  // 	    }
  // 	  ],
  // 	  "shipping_info": { 
  // 	    "first_name": "Sally",
  // 	    "last_name": "Patient",
  // 	    "business_name": "Not applicable",
  // 	    "phone": { 
  // 	      "country_code": "001",
  // 	      "national_number": "5039871234"
  // 	    },
  // 	    "address": { 
  // 	      "line1": "1234 Broad St.",
  // 	      "city": "Portland",
  // 	      "state": "OR",
  // 	      "postal_code": "97216",
  // 	      "country_code": "US"
  // 	    }
  // 	  },
  // 	  "items": [
  // 	    { 
  // 	      "name": "Sutures",
  // 	      "quantity": 200.0,
  // 	      "unit_price": { 
  // 	        "currency": "USD",
  // 	        "value": "5.00"
  // 	      }
  // 	    }
  // 	  ],
  // 	  "payment_term": { 
  // 	    "term_type": "NET_45",
  // 	    "due_date": "2016-12-30 PST"
  // 	  },
  // 	  "note": "Medical Invoice 16 Jul, 2013 PST"
  // 	}

  rest.addHeader('Authorization', sbAuth.getAsString());
  rest.addHeader('Content-Type', 'application/json');

  final invoiceId = 'INV2-XV4B-736P-PLVN-SZCE';

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

  // Send the PUT request containign the JSON in the request body, and get the JSON response.
  final sbJsonRequest = CkStringBuilder();
  json.emitSb(sbJsonRequest);
  final sbJsonResponse = CkStringBuilder();
  try {
    rest.fullRequestSb('PUT', sbPath.getAsString(), sbJsonRequest, sbJsonResponse);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  json.loadSb(sbJsonResponse);

  print('Response Status Code = ${rest.responseStatusCode}');

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

  // Sample response JSON is shown below.

  // Get some information..
  print('email: ${json.stringOf('merchant_info.email')}');
  print('business_name: ${json.stringOf('merchant_info.business_name')}');

  final numItems = json.sizeOfArray('items');
  var i = 0;
  while (i < numItems) {
    json.i = i;
    print('item name: ${json.stringOf('items[i].name')}');
    print('item quantity: ${json.stringOf('items[i].quantity')}');
    print('item currency: ${json.stringOf('items[i].unit_price.currency')}');
    print('item value: ${json.stringOf('items[i].unit_price.value')}');
    print('----');
    i++;
  }

  print('Success.');
}