Node.js

PayPal - Generate Invoice Number

See more PayPal Examples

Generates the next invoice number that is available to the user.

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

Node.js

NODEJS_PRELUDE

function chilkatExample() {

    var success = false;

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

    //  Clear the REST object of any headers or query params from previous requests.
    rest.ClearAllHeaders();
    rest.ClearAllQueryParams();

    rest.AddHeader("Authorization",sbAuth.GetAsString());

    //  Send the POST request with an emtpy body and get the JSON response.
    var sbJsonRequest = new chilkat.StringBuilder();
    var sbJsonResponse = new chilkat.StringBuilder();
    success = rest.FullRequestSb("POST","/v1/invoicing/invoices/next-invoice-number",sbJsonRequest,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 JSON response is shown below.
    console.log(json.Emit());
    console.log("----------------------");
    console.log("Next invoice number: " + json.StringOf("number"));
    console.log("success");

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

    //  	{ 
    //  	  "number": "0003"
    //  	}

}

chilkatExample();