NetSuite

https://docs.oracle.com/en/cloud/saas/netsuite/
Admin
NetSuite is the #1 Cloud ERP, offering a unified business management suite encompassing...
Tokens:8,414,240
Snippets:115,635
Trust Score:9.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### Interactive Setup Prompts

Source: https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/article_89132630266.html

Example of the prompts displayed when running the account:setup command.

```text
Select or create an authentication ID (a custom alias you give to a specific account-role combination):
  ***The authentication ID that you select or create will be set up as default. > Create a new authentication ID.
Enter an authentication ID: myDevRole
```

--------------------------------

### Account setup output example

Source: https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/article_81134826821.html

Displays the expected console output after successfully running the account setup command.

```text
The authentication was successful with the following account and role: My account name [Developer]. This project will use the authentication ID "myAuthId" as default.
```

--------------------------------

### Example SuiteCloud Project Installation Log

Source: https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_1515954518.html

This log shows the output of a SuiteCloud project installation, including validation steps and the application of installation preferences like object locking.

```log
2018-02-02 06:35:43 (PST) Installation started

Info -- Account [(PRODUCTION) MyNetSuiteAccount]

Info -- Publisher ID [com.samples]

Info -- SuiteApp [com.samples.example2 (1.0.1)]

Info -- Framework Version [1.0]

Validate manifest -- Success

Validate deploy file -- Success

Validate script file -- Success

Validate objects -- Success

Validate files -- Success

Validate folders -- Success

Validate preferences -- Success

Validate flags -- Success

Validate account settings -- Success

Validate Custom Objects against the Account -- Success

Info -- Current installed version [1.0.1]

Begin deployment -- com.samples.example2 (1.0.1)

The LOCKING preference type action for the customrecord_sample object has changed to LOCK.

2018-02-02 06:35:45 (PST) Installation COMPLETE (0 minutes 2 seconds) 

        
```

--------------------------------

### SDF Installation Script Example

Source: https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_1554821430.html

Defines an SDF installation record and deployment for a migration script. It includes custom script fields and deployment configurations.

```xml
          <sdfinstallationscript scriptid="customscript_install_script">
  <description>This is my example sdf installation script</description>
  <isinactive>F</isinactive>
  <name>Install Script Demo</name>
  <notifyadmins>F</notifyadmins>
  <notifyemails></notifyemails>
  <notifyowner>T</notifyowner>
  <notifyuser>F</notifyuser>
  <scriptfile>[/SuiteApps/com.example/migrate.js]</scriptfile>
  <scriptcustomfields>
    <scriptcustomfield scriptid="custscript1">
      <accesslevel>2</accesslevel>
      <applyformatting>F</applyformatting>
      <checkspelling>F</checkspelling>
      <defaultchecked>F</defaultchecked>
      <displaytype>NORMAL</displaytype>
      <fieldtype>SELECT</fieldtype>
      <isformula>F</isformula>
      <ismandatory>F</ismandatory>
      <label>test</label>
      <onparentdelete>NO_ACTION</onparentdelete>
      <searchlevel>2</searchlevel>
      <selectrecordtype>[scriptid=customlist_transaction_field]</selectrecordtype>
      <storevalue>T</storevalue>
    </scriptcustomfield>
  </scriptcustomfields>
  <scriptdeployments>
    <scriptdeployment scriptid="customdeploy1">
      <custscript1>[scriptid=customlist_transaction_field.val_a]</custscript1>
      <isdeployed>T</isdeployed>
      <loglevel>ERROR</loglevel>
      <status>RELEASED</status>
      <title>Demo Deployment</title>
    </scriptdeployment>
  </scriptdeployments>
</sdfinstallationscript> 

        
```

--------------------------------

### Install a Plugin for View Initialization

Source: https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_4307439828.html

Install plugins using Backbone.View.beforeInitialize.install to execute custom logic before or after a view is initialized. This example shows how to manage child views.

```javascript
Backbone.View.beforeInitialize.install({
      name: 'compositeView'
   ,   priority: 1
   ,   execute: function ()
      {
         var childViews = _.extend({}, this.childViews, this.constructor.childViews);

         this.childViewInstances =  {};

         this.addChildViews(childViews);

         if (this.options)
         {
            if (this.options.extraChildViews)
            {
               console.warn('DEPRECATED: "options.extraChildViews" is deprecated. Use "options.childViews" instead');
               //Add extra child views from view's initialization options

               this.addChildViews(this.options.extraChildViews);
            }

            if (this.options.extraChildViews)
            {
               //Add child views from view's initialization options
               this.addChildViews(this.options.extraChildViews);
            }
         }
      }
   });

```

--------------------------------

### Bundle Installation Script XML Definition

Source: https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/subsect_1537555588.html

Example of a bundle installation script XML definition, including the root tag and script ID attribute.

```xml
<bundleinstallationscript scriptid="customscript_">

    ...

</bundleinstallationscript>
```

--------------------------------

### REST Search Request Example

Source: https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/article_0728114850.html

Example of a REST GET request to search for customer records where the email starts with 'barbara'.

```APIDOC
## REST Search Request

### Description
This REST API call filters customer records where the email address starts with 'barbara'. The 'q' query parameter is used for filtering.

### Method
GET

### Endpoint
`https://<your_netsuite_instance_domain>/services/rest/record/v1/customer?q=email START_WITH barbara`

### Parameters
#### Query Parameters
- **q** (string) - Required - Filter conditions for the record collection. Supports field names, operators (e.g., START_WITH, CONTAINS, EQUALS), values, logical operators (AND/OR), and precedence grouping with parentheses.
```

--------------------------------

### GET /rest/v1/receipts with Pagination

Source: https://docs.oracle.com/en/cloud/saas/netsuite-suiteprojects-pro/online-help/article_160035263040.html

This example demonstrates how to retrieve a paginated list of receipts using the limit and offset parameters. The `limit` parameter controls the number of objects per page, and the `offset` parameter specifies the starting point for the results.

```APIDOC
## GET /rest/v1/receipts?limit=10&offset=90

### Description
Retrieves a list of receipts with pagination applied. This specific example skips the first 90 objects and returns a page of 10 objects starting from the 91st object.

### Method
GET

### Endpoint
/rest/v1/receipts

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - A limit on the length of the page. You can set the maximum number of objects to be returned per page between 1 and 1000. Default is `100`.
- **offset** (integer) - Optional - A cursor for use in pagination. The response will skip the number of matching objects (or rows) specified using the `offset` parameter. The `offset` must be a positive number divisible by the page `limit`. Default is `0`.

### Response
#### Success Response (200)
A paginated response includes the `meta` property in the JSON-encoded object returned. The `meta` property has the following attributes:
- **rowsPerPage** (integer) - The number of objects (or rows) per page.
- **totalPages** (integer) - The total number of pages in the list.
- **totalRows** (integer) - The total number of objects (or rows) in the list.
- **links** (array) - An array of objects containing direct links to other pages and their relation to the page returned:
  - **first** (string) - the URL for the first page. Not included if the page returned is the first page.
  - **prev** (string) - the URL for the previous page. Not included if the page returned is the first page.
  - **self** (string) - the URL for the current page (the page requested).
  - **next** (string) - the URL for the next page. Not included if the page returned is the last page.
  - **last** (string) - the URL for the last page. Not included if the page returned is the last page.

#### Response Example
```json
{
   "message" : "success",
   "data" : [
      {...}
   ],
   "meta" : {
      "rowsPerPage": 10,
      "totalPages": 85,
      "totalRows": 841,
      "links": [
         {
            "rel": "first",
            "href": "https://company-id.app.netsuitesuiteprojectspro.com/rest/v1/receipts?limit=10"
         },
         {
            "rel": "prev",
            "href": "https://company-id.app.netsuitesuiteprojectspro.com/rest/v1/receipts?limit=10&offset=80"
         },
         {
            "rel": "self",
            "href": "https://company-id.app.netsuitesuiteprojectspro.com/rest/v1/receipts?limit=10&offset=90"
         },
         {
            "rel": "next",
            "href": "https://company-id.app.netsuitesuiteprojectspro.com/rest/v1/receipts?limit=10&offset=20"
         },
         {
            "rel": "last",
            "href": "https://company-id.app.netsuitesuiteprojectspro.com/rest/v1/receipts?limit=10&offset=840"
         }
      ]
   }
}
```
```

--------------------------------

### Create Project Command Examples

Source: https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_1534268059.html

Examples of creating both account customization and SuiteApp project types via the CLI.

```bash
sdfcli createproject [-overwrite] -type ACCOUNTCUSTOMIZATION -parentdirectory d:/myprojects/customizations -projectname MySDFProject
```

```bash
sdfcli createproject [-overwrite] -type SUITEAPP -parentdirectory d:/sdfprojects/mysuiteapps -projectid mysuiteapp123 -projectname MySDFProject2 -publisherid com.netsuite -projectversion 1.0.0
```

--------------------------------

### Fetch SuiteApp Install Base (GET Request)

Source: https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/article_0604110535.html

Use this GET request to retrieve the installation status of a SuiteApp. The response includes details like account information, current status, installed version, and NetSuite version.

```http
GET https://<accountID>.integration.netsuite.com/services/rest/suiteappcontrolcenter/v1/suiteapp/<applicationId>/installation
Authorization: Bearer {TOKEN}
```

```json
{
      "account": {
        "id": "_<accountId>_",
        "name": "Example_AccountName123",
        "type": "production"
      },
      "status": "INSTALLED",
      "installedVersion": "1.2.3",
      "nsVersion": "2024.1",
      "lastUpdated": 1678281916,
      "errors": []
 }
```

```json
{
   "account": {
      "id": "_<accountId>_",
      "name": "Example_AccountName123",
      "type": "production"
   },
   "status": "FAILED_VALIDATION",
   "installedVersion": "1.2.3",
   "nsVersion": "2024.1",
   "lastUpdated": 1678281916,
   "errors": [
         {
           "errorMessage": "Verification failed",
           "errorDbTicket": "jz478bkv19hqrqnh8gvyj"
          }
       ]
     }
```

--------------------------------

### Column.sublistId Example

Source: https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_4600369846.html

This example demonstrates how to load a record, get a sublist, get a column, and then access the sublistId property of the column.

```javascript
// Add additional code 
...
var objRecord = record.load({
    type: record.Type.SALES_ORDER,
    id: 275 
});

var objSublist = objRecord.getSublist({
    sublistId: 'item'
});

var objColumn = objSublist.getColumn({
    fieldId: 'item'
});
//Perform an action with the objColumn.sublistId value 
...
// Add additional code 

```

--------------------------------

### Partitioning Examples

Source: https://docs.oracle.com/en/cloud/saas/netsuite-analytics-warehouse/ndsrg/partitions.html

Illustrates how to create list and range partitions. Ensure column data types and INTERVALVALUE usage comply with the specified rules.

```sql
PARTITIONS
[
   // LIST 
   CREATE LIST PARTITION ON PRODUCT_SALES[PROD_CATEGORY];
   
   // RANGE 
   CREATE RANGE PARTITION ON PROMO_SALES[PROMO_DATE] INTERVALPERIOD["DAY"]
   INTERVALVALUE[15]; 
]
```

--------------------------------

### Package command example

Source: https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_159058236645.html

Demonstrates how to create a ZIP file for a SuiteCloud project and specify the output folder.

```bash
sdfcli package -d C:\sdfProjects -p C:\sdfProjects\projectACP
```

--------------------------------

### Implement View Installation

Source: https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_1519048672.html

The install function is used to perform setup tasks, such as AJAX calls, when the CCT is installed.

```javascript
,  install: function (settings, context_data)
    {
      this._install(settings, context_data);

      // call some ajax here

      var promise = jQuery.Deferred();
      return promise.resolve();
    } 
```

--------------------------------

### Example Translations Sublist for GET Request

Source: https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/article_0301085014.html

This example illustrates the structure of a GET response for the translations sublist, where 'locale' is accessed as a subrecord.

```json
'translations': {
'items': [
{
'locale': { 'id': 'es_ES' },
'description': 'updated description',
'displayName': 'updated displayName',
'language': 'Spanish',
'pageTitle': 'updated pageTitle'
}
]
}
```

--------------------------------

### Example: List Missing Dependencies and Log to File

Source: https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_4788674281.html

This example demonstrates how to list missing dependencies for a project located at 'c:/project/' and write the output to 'test.log'. The command helps identify required features and objects not present in the project.

```bash
sdfcli listmissingdependencies -p c:/project/ -l test.log
```

--------------------------------

### Example: Import Bundle and Create Project

Source: https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_4788674233.html

This example demonstrates how to import a bundle with ID '123' using authentication ID 'AuthId' and save it to the 'c:/SDFproject' directory.

```bash
sdfcli importbundle -bundleid 123 -authid AuthId -p c:/SDFproject
```

--------------------------------

### Example GET Request with Bearer Token

Source: https://docs.oracle.com/en/cloud/saas/netsuite-suiteprojects-pro/online-help/article_159671131758.html

This example demonstrates how to include the OAuth 2.0 access token as a bearer token in the Authorization header for a GET request to the job-codes endpoint.

```APIDOC
## GET /rest/v1/job-codes/

### Description
Retrieves job codes. This example shows how to authenticate using an OAuth 2.0 bearer token.

### Method
GET

### Endpoint
/rest/v1/job-codes/

### Parameters
#### Header Parameters
- **Authorization** (string) - Required - Bearer _<OAuth2_access_token>_

### Request Example
```
GET /rest/v1/job-codes/ HTTP/1.1
Host: company-id.app.netsuitesuiteprojectspro.com
Authorization: Bearer _<OAuth2_access_token>_
```

### Response
#### Success Response (200)
(No specific response fields documented in the source)
```

--------------------------------

### GET Currency Rate Response

Source: https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/article_0723093056.html

Example response for a GET operation on a currency rate.

```APIDOC
## GET /currencyrate/{id}

### Description
Retrieves details of a specific currency rate.

### Method
GET

### Endpoint
/services/rest/record/v1/currencyrate/{id}

### Response
#### Success Response (200)
- **links** (array) - Links related to the currency rate.
- **baseCurrency** (object) - Information about the base currency.
  - **links** (array) - Links related to the base currency.
  - **id** (string) - The ID of the base currency.
  - **refName** (string) - The reference name of the base currency.
- **effectiveDate** (string) - The date the currency rate becomes effective.
- **exchangeRate** (number) - The exchange rate value.
- **fxSourceMethod** (string) - The method used for the foreign exchange source.
- **id** (string) - The ID of the currency rate.
- **lastModifiedDate** (string) - The date and time the currency rate was last modified.
- **transactionCurrency** (object) - Information about the transaction currency.
  - **links** (array) - Links related to the transaction currency.
  - **id** (string) - The ID of the transaction currency.
  - **refName** (string) - The reference name of the transaction currency.

### Response Example
```json
{
    "links": [
        {
            "rel": "self",
            "href": "https://test.suitetalk.api.netsuite.com/services/rest/record/v1/currencyrate/20208"
        }
    ],
    "baseCurrency": {
        "links": [
            {
                "rel": "self",
                "href": "https://test.suitetalk.api.netsuite.com/services/rest/record/v1/currency/1"
            }
        ],
        "id": "1",
        "refName": "USA"
    },
    "effectiveDate": "2025-07-22",
    "exchangeRate": 1.34956,
    "fxSourceMethod": "DIRECT",
    "id": "20208",
    "lastModifiedDate": "2025-07-22T10:16:00Z",
    "transactionCurrency": {
        "links": [
            {
                "rel": "self",
                "href": "https://test.suitetalk.api.netsuite.com/services/rest/record/v1/currency/2"
            }
        ],
        "id": "2",
        "refName": "British pound"
    }
}
```
```

--------------------------------

### Command Output Example

Source: https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/article_89132630266.html

Shows the confirmation message after a successful account setup.

```text
The account has been authenticated for the following company and role: DB 9006 OneWorld for My Account Name [Developer]. This project will use the authentication ID "myDevRole" as default. If you want to change your default credentials, run "suitecloud account:setup" again.
The account has been successfully set up.
```

--------------------------------

### Run account:setup Command

Source: https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/article_89132630266.html

Executes the account setup process in interactive mode.

```bash
suitecloud account:setup
```

--------------------------------

### Example: List Configuration Types

Source: https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_1500042917.html

This example demonstrates how to list all available configuration types for import from a NetSuite account using the 'listconfiguration' command with a specified authentication ID.

```bash
sdfcli listconfiguration -authid AuthId
```

--------------------------------

### BUILTIN.PERIOD Function Syntax Example 2

Source: https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/article_1029114816.html

This example shows the syntax for the BUILTIN.PERIOD function using 'LFY' for the last fiscal year, 'START' for the start of the period, 'ALL' for adjustment, and 'BETWEEN' as the operator.

```sql
BUILTIN.PERIOD('LFY', 'START', 'ALL', 'BETWEEN') 
```

--------------------------------

### CurrencyFormatter.symbol Example

Source: https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_1558031214.html

This example shows how to get the currency symbol using CurrencyFormatter.

```javascript
// Add additional code
...
var curFormatter = format.getCurrencyFormatter({
    currency: "USD"
});
var curSymbol = curFormatter.symbol; // curSymbol is '$'
...
// Add additional code 

```

--------------------------------

### Example of Importing Feature Configuration

Source: https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_1500042748.html

This example demonstrates how to import all features configuration using a specified authentication ID and project path. The output confirms successful import.

```bash
sdfcli importconfiguration -configurationid FEATURES:ALL_FEATURES -authid AuthId -p c:/SDFproject
```

```text
SuiteCloud Development Framework CLI (com.netsuite.ide.core_2021.1.0)
The following objects were imported successfully:
FEATURES:ALL_FEATURES
```

--------------------------------

### Create Directories and Set Permissions

Source: https://docs.oracle.com/en/cloud/saas/netsuite-analytics-warehouse/nsawa/run-remote-agent-docker-linux.html

Commands to prepare the necessary directory structure and permissions on the host VM.

```bash
mkdir -p /faw/software/remoteagent/config
chmod -R 0777 /faw/software/remoteagent/
mkdir /faw/logs/RemoteAgent/config
chmod -R 0777 /faw/logs/RemoteAgent/config
```
Tokens:
Raw