Disable Tax Fields

Script: Disable Tax Fields
Script Type	SuiteScript 2.x Client Script Type
Modules Used	N/runtime Module N/currentRecord Module - This module is available to all scripts as a provided context object. You do not need to explicitly load this module as a dependency in your define or require statement, however, you may if you want. This tutorial does not explicitly load this module. N/log Module - This module is available to all scripts as a global object. However, you should explicitly load this module to avoid conflicts with other objects that may be named ‘log’.
Entry Points	pageInit(scriptContext)

Start with required opening lines

JSDoc comments and a define function are required at the top of the script file. The JSDoc comments in this script indicate that it is a SuiteScript 2.x (2.0 or 2.1) client script. The script uses two SuiteScript modules specified in the define statement:

• N/runtime - provides access to runtime information including script parameters

• N/log – allows you to log execution details

Start a new script file using any text editor and place the following JSDoc comments and define function at the top of the file:

                /**
 * @NApiVersion 2.1
 * @NScriptType ClientScript
 * @NModuleScope SameAccount
 */

define(['N/runtime', 'N/log'], (runtime, log) => {
}); 

              

Create the entry point functions

This script is triggered on the pageInit entry point when a sales transaction (specifically cash refunds, cash sales, cash memos, invoices, sales orders, and return authorizations) is created or edited. A try-catch block is used to log any errors that might occur during script execution in the entry point function. Most of the script code will be placed in one of the try blocks.

Add the following entry point function definitions and initial try-catch block statements at the top of the define function:

                function pageInit(scriptContext) {
    try {
    } catch(error) {
        if (error !== undefined) {
            log.error({
                title: 'Process Error in pageInit,
                details: error
            });
            throw error;
        } 
    }
} 

              

Complete the pageInit function

Add the following code at the top of the try block of the pageInit function:

                const objRecord = scriptContext.currentRecord;
const stRecordType = objRecord.type;
const stFuncName = 'pageInit_DisableTaxFields_' + stRecordType; 

              

If the transaction is in create or edit mode, we want to get the script parameter and user role information.

Add the following code within the try block of the pageInit function:

                if (scriptContext.mode !== 'copy') {
   const objContext = runtime.getCurrentScript()
   const stAllowList = objContext.getParameter({
      name: 'custscript_tax_allowlist'
    });
   const stUserRole = runtime.getCurrentUser().role;
   const arrExclusionRoleList = stAllowList.split(','); 

              

If the script parameter allow list parameter is empty, we need to log an error.

Add the following code within the try block of the pageInit function:

                if (NSUtil.isEmpty(stAllowList)) {
    log.error({
       title: stFuncName,
       details: 'Script parameter is empty. Script will now exit'
     });
  return
} 

              

We will disable fields according to the US subsidiary of the customer on the transaction record. To accomplish this, we will check if the tax item field exists when a customer is selected. If the tax item field exists and the user role does not match the allow list parameter, we will disable the Taxable, Tax Item, and Tax Rate fields.

Add the following code within the try block of the pageInit function:

                const taxitem = objRecord.getField({
   fieldId: 'taxitem'
});
if (taxitem && !NSUtil.inArray(stUserRole, arrExclusionRoleList)) {
    const istaxable = objRecord.getField({
       fieldId: 'istaxable'
    });
    const taxrate = objRecord.getField({
       fieldId: 'taxrate'
     });
     istaxable.isDisabled = true;
     taxitem.isDisabled = true;
     taxrate.isDisabled = true;
} 

              

The pageInit function should now be complete.

Create the return statement

This script associates the pageInit function to the pageInit entry point.

Add the following code immediately above the closing }); in your script:

                return {
    pageInit: pageInit
}; 

              

Add the utility functions

A utility function is used to evaluate the script parameters and compare them to the user’s role and the subsidiary of the transaction.

Add the following code at the end of your script following the end of the define function.

                const NSUtil = {
    isEmpty : function(stValue) {
        if ((stValue === '') || (stValue === null) || (stValue === undefined)) { 
            return true;
        } 
    },
    inArray : function(stValue, arrValue) {
        let bIsValueFound = false;
        for (let i = arrValue.length; i >= 0; i--) {
            if (stValue == arrValue[i]) {
                bIsValueFound = true;
                break;
            }
        }
        return bIsValueFound;
    }
} 

              

Save your script file

You need to save your script file so you can load it to the NetSuite File Cabinet. Before you save your script file, you may want to adjust the indentation so that the script is readable. Refer to The Complete Script for suggested indentation.

When you are happy with how your script file reads, save it as a .js file (for example, cs_disableTaxFields.js).

To deploy the script on cash refund transactions:

1. Go to Customization > Scripting > Scripts and click Deployments for the script record you created in Step 2: Create the Script Record).

2. Click New Deployment.

3. On the Script Deployment page, enter the following values:

   Field	Value
   Applies To	Cash Refund
   ID	_cs_disable_tax_fields_cr NetSuite prepends 'custdeploy' to this ID.
   Status	Testing The Testing status allows the script owner to test the script without affecting other users in the account.
   Log Level	Debug The Debug level will write all log.debug statements in the script to the Execution Log tab of the script deployment record as well as all errors.
   Audience > Roles	Check Select All

4. Click Save.

To deploy the script on cash sale transactions:

1. Go to Customization > Scripting > Scripts and click Deployments for the script record you created in Step 2: Create the Script Record).

2. Click New Deployment.

3. On the Script Deployment page, enter the following values:

   Field	Value
   Applies To	Cash Sale
   ID	_cs_disable_tax_fields_cs NetSuite prepends 'custdeploy' to this ID.
   Status	Testing The Testing status allows the script owner to test the script without affecting other users in the account.
   Log Level	Debug The Debug level will write all log.debug statements in the script to the Execution Log tab of the script deployment record as well as all errors.
   Audience > Roles	Check Select All.

4. Click Save.

To deploy the script on credit memo transactions:

1. Go to Customization > Scripting > Scripts and click Deployments for the script record you created in Step 2: Create the Script Record).

2. Click New Deployment.

3. On the Script Deployment page, enter the following values:

   Field	Value
   Applies To	Credit Memo
   ID	_cs_disable_tax_fields_cm NetSuite prepends 'custdeploy' to this ID.
   Status	Testing The Testing status allows the script owner to test the script without affecting other users in the account.
   Log Level	Debug The Debug level will write all log.debug statements in the script to the Execution Log tab of the script deployment record as well as all errors.
   Audience > Roles	Check Select All.

4. Click Save.

To deploy the script on invoice transactions:

1. Go to Customization > Scripting > Scripts and click Deployments for the script record you created in Step 2: Create the Script Record).

2. Click New Deployment.

3. On the Script Deployment page, enter the following values:

   Field	Value
   Applies To	Invoice
   ID	_cs_disable_tax_fields_in NetSuite prepends 'custdeploy' to this ID.
   Status	Testing The Testing status allows the script owner to test the script without affecting other users in the account.
   Log Level	Debug The Debug level will write all log.debug statements in the script to the Execution Log tab of the script deployment record as well as all errors.
   Audience > Roles	Check Select All.

4. Click Save.

To deploy the script on sales order transactions:

1. Go to Customization > Scripting > Scripts and click Deployments for the script record you created in Step 2: Create the Script Record).

2. Click New Deployment.

3. On the Script Deployment page, enter the following values:

   Field	Value
   Applies To	Sales Order
   ID	_cs_disable_tax_fields_so NetSuite prepends 'custdeploy' to this ID.
   Status	Testing The Testing status allows the script owner to test the script without affecting other users in the account.
   Log Level	Debug The Debug level will write all log.debug statements in the script to the Execution Log tab of the script deployment record as well as all errors.
   Audience > Roles	Check Select All.

4. Click Save.

To deploy the script on return authorization transactions:

1. Go to Customization > Scripting > Scripts and click Deployments for the script record you created in Step 2: Create the Script Record).

2. Click New Deployment.

3. On the Script Deployment page, enter the following values:

   Field	Value
   Applies To	Return Authorization
   ID	_cs_disable_tax_fields_ra NetSuite prepends 'custdeploy' to this ID.
   Status	Testing The Testing status allows the script owner to test the script without affecting other users in the account.
   Log Level	Debug The Debug level will write all log.debug statements in the script to the Execution Log tab of the script deployment record as well as all errors.
   Audience > Roles	Check Select All.

4. Click Save.

• SuiteCloud Customization Tutorials
• Add Custom Button to Execute a Suitelet
• Calculate Commission on Sales Orders
• Copy a Value to the Item Column
• Hide a Column in a Sublist
• Populate Item Substitution
• Set a Default Posting Period in a Custom Field
• Set Purchase Order Exchange Rate
• Set the Item Amount to Zero for Marketing Orders
• Set Default Values in a Sublist
• Track Customer Deposit Balances
• Validate Order on Entry