Java
Chilkat2 Java
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
Chilkat Java Downloads
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.Rest;
import com.chilkatsoft.chilkat2.StringBuilder;
public class ChilkatExample {
public static void main(String[] args) {
// 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)
JsonObject jsonToken = new JsonObject();
jsonToken.loadFile("qa_data/tokens/paypal.json");
// Build the Authorization request header field value.
StringBuilder sbAuth = new 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 rest = new Rest();
boolean bAutoReconnect = true;
try {
rest.connect("api.sandbox.paypal.com", 443, true, bAutoReconnect);
} catch (ChilkatException e) {
System.out.println(e.getLastErrorText());
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:
JsonObject json = new JsonObject();
json.setEmitCompact(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");
String invoiceId = "INV2-XV4B-736P-PLVN-SZCE";
StringBuilder sbPath = new StringBuilder();
sbPath.append("/v1/invoicing/invoices/");
sbPath.append(invoiceId);
// Send the PUT request containign the JSON in the request body, and get the JSON response.
StringBuilder sbJsonRequest = new StringBuilder();
json.emitSb(sbJsonRequest);
StringBuilder sbJsonResponse = new StringBuilder();
try {
rest.fullRequestSb("PUT", sbPath.getAsString(), sbJsonRequest, sbJsonResponse);
} catch (ChilkatException e) {
System.out.println(e.getLastErrorText());
return;
}
json.loadSb(sbJsonResponse);
System.out.println("Response Status Code = " + rest.getResponseStatusCode());
// Did we get a 200 success response?
if (rest.getResponseStatusCode() != 200) {
System.out.println(json.emit());
System.out.println("Failed.");
return;
}
// Sample response JSON is shown below.
// Get some information..
System.out.println("email: " + json.stringOf("merchant_info.email"));
System.out.println("business_name: " + json.stringOf("merchant_info.business_name"));
int numItems = json.sizeOfArray("items");
int i = 0;
while (i < numItems) {
json.setI(i);
System.out.println("item name: " + json.stringOf("items[i].name"));
System.out.println("item quantity: " + json.stringOf("items[i].quantity"));
System.out.println("item currency: " + json.stringOf("items[i].unit_price.currency"));
System.out.println("item value: " + json.stringOf("items[i].unit_price.value"));
System.out.println("----");
i = i + 1;
}
System.out.println("Success.");
}
}