Sample code for 30+ languages & platforms
Java

PayPal - Show Invoice Details

See more PayPal Examples

Shows details for a PayPal invoice, by ID.

See also PayPal Show Invoice Details REST API Reference

Chilkat Java Downloads

Chilkat2 Java
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.64 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..
        // ----------------------------------------------------------------------------------------------

        rest.addHeader("Authorization", sbAuth.getAsString());

        String invoiceId = "INV2-XV4B-736P-PLVN-SZCE";

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

        // Send the GET request and get the JSON response.
        StringBuilder sbJsonResponse = new StringBuilder();
        try {
            rest.fullRequestNoBodySb("GET", sbPath.getAsString(), sbJsonResponse);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        JsonObject json = new JsonObject();
        json.setEmitCompact(false);
        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.");

        // ---------------------------------------------------
        // A sample response:

        //     {
        //       "id": "INV2-XV4B-736P-PLVN-SZCE",
        //       "number": "0002",
        //       "template_id": "TEMP-8HS37702UW384535K",
        //       "status": "DRAFT",
        //       "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": 100.0,
        //           "unit_price": {
        //             "currency": "USD",
        //             "value": "5.00"
        //           }
        //         }
        //       ],
        //       "invoice_date": "2016-11-15 PST",
        //       "payment_term": {
        //         "term_type": "NET_45",
        //         "due_date": "2016-12-30 PST"
        //       },
        //       "tax_calculated_after_discount": false,
        //       "tax_inclusive": false,
        //       "note": "Medical Invoice 16 Jul, 2013 PST",
        //       "total_amount": {
        //         "currency": "USD",
        //         "value": "500.00"
        //       },
        //       "metadata": {
        //         "created_date": "2016-11-15 08:09:21 PST"
        //       },
        //       "links": [
        //         {
        //           "rel": "self",
        //           "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE",
        //           "method": "GET"
        //         },
        //         {
        //           "rel": "send",
        //           "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE/send",
        //           "method": "POST"
        //         },
        //         {
        //           "rel": "update",
        //           "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE/update",
        //           "method": "PUT"
        //         },
        //         {
        //           "rel": "delete",
        //           "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE",
        //           "method": "DELETE"
        //         }
        //       ]
        //     }
        //
    }
}