(Node.js) PayPal - Show Invoice Details

Shows details for a PayPal invoice, by ID.

See also PayPal Show Invoice Details REST API Reference

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

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

    // Build the Authorization request header field value.
    var 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.
    var rest = new chilkat.Rest();
    var bAutoReconnect = true;
    var success = rest.Connect("api.sandbox.paypal.com",443,true,bAutoReconnect);
    if (success !== true) {
        console.log(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());

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

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

    // Send the GET request and get the JSON response.
    var sbJsonResponse = new chilkat.StringBuilder();
    success = rest.FullRequestNoBodySb("GET",sbPath.GetAsString(),sbJsonResponse);
    if (success !== true) {
        console.log(rest.LastErrorText);
        return;
    }

    var json = new chilkat.JsonObject();
    json.EmitCompact = false;
    json.LoadSb(sbJsonResponse);

    console.log("Response Status Code = " + rest.ResponseStatusCode);

    // Did we get a 200 success response?
    if (rest.ResponseStatusCode !== 200) {
        console.log(json.Emit());
        console.log("Failed.");
        return;
    }

    // Sample response JSON is shown below.

    // Get some information..
    console.log("email: " + json.StringOf("merchant_info.email"));
    console.log("business_name: " + json.StringOf("merchant_info.business_name"));

    var numItems = json.SizeOfArray("items");
    var i = 0;
    while (i < numItems) {
        json.I = i;
        console.log("item name: " + json.StringOf("items[i].name"));
        console.log("item quantity: " + json.StringOf("items[i].quantity"));
        console.log("item currency: " + json.StringOf("items[i].unit_price.currency"));
        console.log("item value: " + json.StringOf("items[i].unit_price.value"));
        console.log("----");
        i = i+1;
    }

    console.log("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"
    // 	    }
    // 	  ]
    // 	}
    // 

}

chilkatExample();