Create a Custom Plug-in Implementation for Sending E-Documents
The following sample shows how to create a custom plug-in implementation for sending e-documents.
This script can also be found at Creating a Custom Plug-in Implementation for Sending E-Documents as part of the Electronic Invoicing Adminstrator Guide.
Note:
This sample script uses the define function, which is required for an entry point script (a script you attach to a script record and deploy). You must use the require function if you want to copy the script into the SuiteScript Debugger and test it. For more information, see SuiteScript Debugger.
The following code is a sample custom plug-in implementation for sending e-documents.
/**
* @NApiVersion 2.0
* @NScriptType plugintypeimpl
*/
define(["../../lib/string_formatter",
"../../lib/wrapper/ns_wrapper_error",
"../../lib/wrapper/ns_wrapper_config",
"../../lib/wrapper/ns_wrapper_email",
"../../lib/wrapper/ns_wrapper_file",
"../../app/einvoice/app_einvoice_notifier",
"../../lib/translator"],
function(stringFormatter, error, config, email, file, notifier, translator) {
/**
* send - This function is the entry point of our plugin script
* @param {Object} plugInContext
* @param {String} plugInContext.scriptId
* @param {String} plugInContext.sendMethodId
* @param {String} plugInContext.eInvoiceContent
* @param {Object} plugInContext.customer
* @param {String} plugInContext.customer.id
* @param {Array} plugInContext.customer.recipients
* @param {Object} plugInContext.transaction
* @param {String} plugInContext.transaction.number
* @param {String} plugInContext.transaction.id
* @param {String} plugInContext.transaction.poNum
* @param {Object} plugInContext.sender
* @param {String} plugInContext.sender.id
* @param {String} plugInContext.sender.name
* @param {String} plugInContext.sender.email
* @param {Array} plugInContext.attachmentFileIds
*
* @returns {Object} result
* @returns {Boolean} result.success
* @returns {String} result.message
*/
function send(pluginContext) {
var MSG_NO_EMAIL = translator.getString("ei.sending.sendernoemail");
var MSG_SENT_DETAILS = translator.getString("ei.sending.sentdetails");
var senderDetails = pluginContext.sender;
var customer = pluginContext.customer;
var transaction = pluginContext.transaction;
var recipientList = customer.recipients;
var result = {};
var parameters;
if (!senderDetails.email) {
parameters = {
EMPLOYEENAME: senderDetails.name
};
stringFormatter.setString(MSG_NO_EMAIL);
stringFormatter.replaceParameters(parameters);
result = {
success: false,
message: stringFormatter.toString()
};
} else {
var invoiceSendDetails = {
number: transaction.number,
poNumber: transaction.poNum,
transactionType : transaction.type,
eInvoiceContent: pluginContext.eInvoiceContent,
attachmentFileIds: pluginContext.attachmentFileIds
};
notifier.notifyRecipient(senderDetails.id, recipientList, invoiceSendDetails);
parameters = {
SENDER: senderDetails.email,
RECIPIENTS: recipientList.join(", ")
};
stringFormatter.setString(MSG_SENT_DETAILS);
stringFormatter.replaceParameters(parameters);
result = {
success: true,
message: stringFormatter.toString()
};
}
return result;
}
return {
send: send
};
});