Pattern to Make SuiteScript Call to NetSuite SuiteTalk Web Services

This article is relevant if you are trying to make an NetSuite Web Services call and you are in SuiteScript, not an external application.

Background

When most people talk about NetSuite’s Web Services technologies, they are referencing how external applications can interact with the NetSuite platform. However, consider the case where you need to make a NetSuite SuiteScript call to NetSuite’s Web Services.  We see this use case come up where there is a NetSuite function that is supported in the SuiteTalk technologies but is not supported in the SuiteScript area.  In these situations, while we wish we wouldn’t have to, we need to call out to Web Services to take care of the business problem.

Technically Not Best Practice but Gets the Job Done

NetSuite is clear that they do not want NetSuite authentication credentials stored in custom fields to make calls to the Web Services tier.  Instead, you should use a Single Sign On approach to configure your application to allow for access to NetSuite’s Web Services.   Single Sign on has overhead and is a discussion in itself.   However, not withstanding the credential consideration, you may be wondering how to make a SuiteScript call out to a NetSuite SuiteTalk Web Services.

Example SuiteScript to SuiteTalk Functions

The following custom functions can help you see the code pattern.  The first function builds the XML SOAP message.  Notice the credential information is stored in message body.  The next function formats the request to to include the necessary HTTPS headers as well as indicate the reference method that will be called.  Once you get the result back from your call, you will need to parse the XML response to look for the information you need.

function xml_ws(sWS_URL, sWS_Acct, sWS_User, sWS_Pw, sWS_Role, period_id) {

	return '<soap:Envelope xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">' +
    '<soap:Header>'+
        '<passport xmlns="urn:messages_2013_1.platform.webservices.netsuite.com">'+
            '<email xmlns="urn:core_2013_1.platform.webservices.netsuite.com">'+sWS_User+'</email>'+
            '<password xmlns="urn:core_2013_1.platform.webservices.netsuite.com">'+sWS_Pw+'</password>'+
            '<account xmlns="urn:core_2013_1.platform.webservices.netsuite.com">'+sWS_Acct+'</account>'+
            '<role internalId="'+sWS_Role+'" xmlns="urn:core_2013_1.platform.webservices.netsuite.com"/>'+
        '</passport>'+
        '<preferences xmlns="urn:messages_2013_1.platform.webservices.netsuite.com">'+
            '<warningAsError>false</warningAsError>'+
        '</preferences>'+
    '</soap:Header>'+
    '<soap:Body>'+
		'<getConsolidatedExchangeRate>'+
	        '<consolidatedExchangeRateFilter>'+
	           '<period internalId="'+period_id+'" />'+
	           '<toSubsidiary internalId="1" />'+
	        '</consolidatedExchangeRateFilter>'+
         '</getConsolidatedExchangeRate>'+
      '</soap:Body>'+
   '</soap:Envelope>';
}

//sample soap_action
var soap_action = 'getPostingTransactionSummary';

function invoke_ws(xml, soap_action, sUrl){

    //Set up Headers
    var headers = new Array();
    headers['User-Agent-x'] = 'SuiteScript-Call';
    headers['Content-Type'] = 'text/xml';
    headers['SOAPAction'] = soap_action;

    var resp = null;
    if (xml)  {
    	// blindly re-try upon error
    	try{
    		resp = nlapiRequestURL( sUrl, xml , headers );
    	}catch(e){
    		resp = nlapiRequestURL( sUrl, xml , headers );
    	}
    } else {
    	resp = nlapiRequestURL( sUrl, null , headers );
    }
    return resp.getBody();
}

These functions can be excuted in NetSuite UserEvents (remember, they may be slow), SuiteLets, or ideally, in scheduled scripts.

Get Assistance

Because of its ability to be adapted and programmed, the NetSuite platform is excellent for taking care of business problems.  Contact us if you are looking to get more out of your NetSuite account.