SuiteScript Supported Records

Note:

The topic applies to all versions of SuiteScript.

The following table lists all NetSuite records that are scriptable with SuiteScript. This table includes:

Also note that all subrecords are scriptable from the line item level, unless stated otherwise.

The following help topics contain additional information about using the SuiteScript Records Browser:

Record Name

Record ID

Record Category

Scripting Level

Scriptable in Client SuiteScript

Scriptable in Server SuiteScript

Account

account

List

Full

Checked

Accounting Book

accountingbook

List

Copy Not Supported

Checked

Accounting Context

accountingcontext

List

Read, Create, Update, Copy, Delete, and Search

Checked

Checked

Accounting Period

accountingperiod

List

Read and Search Only

Checked

Checked

Activity

activity

Activity

Search Only

Checked

Checked

Address

See Subrecord Scripting Overview.

addressbookaddress

Subrecord

See About the Address Subrecord.

Checked

Server scripts must access through the parent record.

Advanced Intercompany Journal Entry

advintercompanyjournalentry

Transaction

Full

Checked

Checked

Allocation Schedule

allocationschedule

List

Create, Read, Update, and Delete

Checked

Checked

Amortization Schedule

amortizationschedule

List

Copy, Create, and Delete Not Allowed

Checked

Amortization Template

amortizationtemplate

List

Full

Checked

Assembly Build

assemblybuild

Transaction

Full

Checked

Assembly Item

assemblyitem

Item

Full

Checked

Assembly Unbuild

assemblyunbuild

Transaction

Full

Checked

Automated Clearing House

automatedclearinghouse

List

Copy and Transform Not Supported.

Checked

Checked

Balance Transactions by Segments

balancetrxbysegments

Transaction

Create, Read, and Search

Checked

Billing Account

billlingaccount

List

Full

Checked

Checked

Billing Class

billingclass

List

Full

 

Checked

Billing Rate Card

billingratecard

List

Read, Create, Update, Delete, and Search

Copy and Transform Not Supported

Checked

Checked

Billing Schedule

billingschedule

List

Full

Checked

Bin

bin

List

Full

Checked

Bin Putaway Worksheet

binworksheet

Transaction

Copy and Update Not Supported

Dynamic Mode Only

Bin Transfer

bintransfer

Transaction

Full

Checked

Blanket Purchase Order

blanketpurchaseorder

Transaction

Full

Checked

Checked

BOM

bom

List

Read, Create, Update, Copy, Delete, and Search

Checked

Checked

BOM Revision

bomrevision

List

Read, Create, Update, Copy, Delete, and Search

Checked

Bonus

bonus

Entity

Read, Create, Update, Copy, Delete, and Search

Checked

Checked

Bonus Type

bonustype

Entity

Read, Create, Update, Copy, Delete, and Search

Checked

Checked

Budget Exchange Rate

budgetexchangerate

List

Read, Update, and Search

Checked

Checked

Campaign

campaign

Marketing

Full

Checked

Checked

Campaign Response

campaignresponse

Marketing

Full

Checked

Checked

Campaign Template

campaigntemplate

Marketing

Search Not Supported

Checked

Case

supportcase

Support

Full

Checked

Checked

Cash Refund

cashrefund

Transaction

Full

Checked

Checked

Cash Sale

cashsale

Transaction

Full

Checked

Checked

Change Order

subscriptionchangeorder

Transaction

Full

Checked

Checked

Charge

charge

Transaction

Full

Checked

Check

check

Transaction

Full

Checked

Checked

Class

classification

List

Server SuiteScript Only

Checked

CMS Content

cmscontent

Web Site

Create, Update, and Search Only

Attach, Transform, and Copy Not Supported

Checked

CMS Content Type

cmscontenttype

Web Site

Create, Update, and Search Only

Attach, Transform, and Copy Not Supported

Checked

CMS Page

cmspage

Web Site

Create, Update, and Search Only

Attach, Transform, and Copy Not Supported

Checked

Commerce Category

commercecategory

Website

Attach, Transform, and Copy Not Supported

Checked

Competitor

competitor

Entity

Full

Checked

Checked

Consolidated Exchange Rate

consolidatedexchangerate

List

Read, Update, and Search Only

Create and Delete Not Supported

Checked

Checked

Contact

contact

Entity

Full

Checked

Checked

Contact Category

contactcategory

List

Full

Checked

Checked

Contact Role

contactrole

List

Full

Checked

Checked

Cost Category

costcategory

List

Full

Checked

Checked

Coupon Code

couponcode

Marketing

Full

Checked

Checked

Credit Card Charge

creditcardcharge

Transaction

Full

Checked

Credit Card Refund

creditcardrefund

Transaction

Full

Checked

Credit Memo

creditmemo

Transaction

Full

Checked

Checked

Currency

currency

List

Full — with Multiple Currencies Feature Enabled

Read Only — without Multiple Currencies Feature

Checked

Custom List

See Custom List IDs

Custom

Search Only

Checked

Checked

Custom Record

See Custom Record IDs

Custom

Full

Checked

Checked

Customer

customer

Entity

Full

Checked

Checked

Customer Category

customercategory

List

Search Not Supported

Checked

Checked

Customer Deposit

customerdeposit

Transaction

Full

Checked

Checked

Customer Message

customermessage

List

Full

Checked

Checked

Customer Payment

customerpayment

Transaction

Copy and Create Not Allowed

Checked

Customer Refund

customerrefund

Transaction

Full

Checked

Customer Status

customerstatus

Entity

Full

Checked

Checked

Customer-Subsidiary Relationship

customersubsidiaryrelationship

List

Full

Checked

Checked

Department

department

List

Server SuiteScript Only

Checked

Deposit

deposit

Transaction

Copy Not Supported

Dynamic Mode Not Supported

Checked

Checked

Deposit Application

depositapplication

Transaction

Create Not Allowed

Checked

Checked

Description Item

descriptionitem

Item

Full

Checked

Checked

Discount Item

discountitem

Item

Full

Checked

Checked

Download Item

downloaditem

Item

Full

Checked

Checked

Driver’s License

driverslicense

List

Full

Checked

Checked

User event scripts are not supported.

Email Template

emailtemplate

Marketing

Search Not Supported

Checked

Employee

employee

Entity

Full

Checked

Checked

Employee Change Request

employeechangerequest

List

Copy and Transform Not Supported

Checked

Checked

Employee Change Request Type

employeechangerequesttype

List

Copy and Transform Not Supported

Checked

Checked

Employee Expense Source Type

employeeexpensesourcetype

Transaction

Full

Checked

Checked

Employee Status

employeestatus

Entity

Transform Not Supported

Checked

Checked

Employee Type

employeetype

Entity

Transform Not Supported

Checked

Checked

Entity

entity

Entity

Search Only

Estimate

estimate

Transaction

Full

Checked

Checked

Event

calendarevent

Activity

Full

Checked

Checked

Expense Category

expensecategory

List

Full

Checked

Expense Report

expensereport

Transaction

Full

Checked

Checked

Expense Report Policy

expensereportpolicy

Transaction

Read, create, update, copy, delete, and search.

Checked

Checked

Fair Value Price

fairvaluepricelist

List

Create, Delete, and Search Only

Copy Not Allowed

Checked

File

file

File Cabinet

Search Only

Checked

Financial Institution

financialinstitution

List

Read, Create, Update, Delete, and Search

Checked

Folder

folder

File Cabinet

Full

Checked

beforeLoad event is not supported on user event scripts.

Format Profile

formatprofile

List

Read, Create, Update, and Delete

Checked

Checked

Fulfillment Request

fulfillmentrequest

Transaction

Create and Copy Not Supported

Checked

Checked

General Token

See Payment Instruments

generaltoken

List

Copy and Transform Not Supported

Checked

Checked

Generic Resource

genericresource

Entity

Copy Not Supported

Checked

Checked

Gift Certificate

giftcertificate

List

Full

Checked

Checked

Gift Certificate Item

giftcertificateitem

Item

Full

Checked

Checked

GL Audit Numbering Sequence

glnumberingsequence

Transaction

Read, Create, Update, Copy, Search

Checked

Checked

Global Account Mapping

globalaccountmapping

List

Full

Checked

Global Inventory Relationship

globalinventoryrelationship

List

Read, Create, Edit, Delete, Search

Copy Not Supported

Checked

Checked

Goal

goal

List

Full

Checked

Checked

Group

entitygroup

List

Full

Checked

Imported Employee Expense

importedemployeeexpense

Transaction

Full

Checked

Checked

Inbound Shipment

inboundshipment

List

Copy and Transform Not Supported

Checked

Checked

Intercompany Allocation Schedule

intercompallocationschedule

List

Create, Read, Update, and Delete

Checked

Checked

Intercompany Journal Entry

intercompanyjournalentry

Transaction

Full

Checked

Checked

Intercompany Transfer Order

intercompanytransferorder

Transaction

Full

Checked

Checked

Inventory Adjustment

inventoryadjustment

Transaction

Full

Checked

Checked

Inventory Cost Revaluation

inventorycostrevaluation

Transaction

Full

Checked

Checked

Inventory Count

inventorycount

Transaction

Full

Checked

Checked

Inventory Detail

inventorydetail

Subrecord

See Creating an Inventory Detail Sublist Subrecord Example.

Checked

Server scripts must access through the parent record

Inventory Item

(Also referred to in the UI as Inventory Part)

inventoryitem

Item

Full

Checked

Checked

Inventory Number

inventorynumber

List

Copy, Create, and Delete Not Supported

Checked

Inventory Status

inventorystatus

List

Full

Checked

Checked

Inventory Status Change

inventorystatuschange

Transaction

Full

Checked

Checked

Inventory Transfer

inventorytransfer

Transaction

Full

Checked

Invoice

invoice

Transaction

Full

Checked

Checked

Issue

issue

Support

Full

Checked

Checked

Issue Product

issueproduct

Support

Copy, transform and search not supported.

Checked

Checked

Issue Product Version

productversion

Support

Copy, transform and search not supported.

Checked

Checked

Item Account Mapping

itemaccountmapping

List

Full

Checked

Item Collection

itemcollection

List

Copy and Transform Not Supported

Checked

Checked

Item Collection Item Map

itemcollectionmap

List

Update, Copy, and Transform Not Supported

Checked

Checked

Item Demand Plan

itemdemandplan

Transaction

Copy Not Supported, No Available Transforms

Checked

Checked

Item Fulfillment

itemfulfillment

Transaction

Copy and Create Not Supported

Checked

Checked

Item Group

itemgroup

Item

Full

Checked

Checked

Item Location Configuration

itemlocationconfiguration

List

Read, Create, Edit, Delete, and Search

Checked

Item Process Family

itemprocessfamily

List

Full

Checked

Checked

Item Process Group

itemprocessgroup

List

Full

Checked

Checked

Item Receipt

itemreceipt

Transaction

Copy and Create Not Supported

Checked

Checked

Item Revision

itemrevision

List

Full

Checked

Item Search

item

Item

Search Only

Item Supply Plan

itemsupplyplan

Transaction

Full

Checked

Checked

Job

job

Entity

Copy and Transform Not Supported

Checked

Checked

Job Requisition

jobrequisition

Entity

Copy and Transform Not Supported

Checked

Checked

Journal Entry

journalentry

Transaction

Full

Checked

Checked

Kit Item

kititem

Item

Full

Checked

Kudos Feature Records

kudos

List

Full

Only the inactive field can be edited.

Checked

Landed Cost

landedcost

Transaction

Full

Checked

Lead

lead

Entity

Full

Checked

Checked

Location

location

List

Server SuiteScript Only

Checked

Lot Numbered Assembly Item

lotnumberedassemblyitem

Item

Full

Checked

Checked

Lot Numbered Inventory Item

lotnumberedinventoryitem

Item

Full

Checked

Checked

Manufacturing Cost Template

manufacturingcosttemplate

List

Full

Checked

Manufacturing Operation Task

manufacturingoperationtask

Transaction

Copy Not Supported

Checked

Checked

Manufacturing Planned Time

mfgplannedtime

Transaction

Search Only

Checked

Checked

Manufacturing Routing

manufacturingrouting

List

Full

Checked

Markup Item

markupitem

Item

Full

Checked

Checked

Memorized Transaction Definition

memdoc

Transaction

Read, Update, Delete, and Search

Checked

Checked

Merchandise Hierarchy Level

merchandisehierarchylevel

List

Read, Create, Edit, Delete, and Search

Checked

Merchandise Hierarchy Node

merchandisehierarchynode

List

Read, Create, Edit, Delete, and Search

Checked

Merchandise Hierarchy Version

merchandisehierarchyversion

List

Read, Create, Edit, Delete, and Search

Checked

Message

message

Communication

For details, see Message.

Checked

Multi-Book Accounting Transaction

accountingtransaction

Transaction

Search Only

Checked

Checked

Nexus

nexus

List

Copy Not Supported

Checked

Non-Inventory Part

noninventoryitem

Item

Full

Checked

Checked

Note

note

Communication

Full

Checked

Note Type

notetype

List

Full

Checked

Checked

Opportunity

opportunity

Transaction

Full

Checked

Checked

Order Reservation

orderreservation

Transaction

Created, read, updated, deleted, copied, and searched.

It cannot be transformed

Checked

Checked

Order Schedule

orderschedule

Transaction

See Subrecord Scripting Overview.

Checked

Server scripts must access through the parent record

Order Type

ordertype

List

Full

Checked

Checked

Organization Value

organizationvlaue

List

Full

Checked

Other Charge Item

otherchargeitem

Item

Full

Other Government-Issued ID

othergovernmentissuedid

List

Full

Checked

Checked

User event scripts are not supported.

Other Name

othername

Entity

Full

Checked

Other Name Category

othernamecategory

List

Full

Checked

Checked

Partner

partner

Entity

Full

Checked

Checked

Partner Category

partnercategory

List

Full

Checked

Checked

Passport

passport

List

Full

Checked

Checked

User event scripts are not supported.

Paycheck

paycheck

Transaction

Read and Update Only

Checked

Checked

Paycheck Journal

paycheckjournal

Transaction

Full

Checked

Checked

Payment Card

See Payment Instruments

paymentcard

List

Copy and Transform Not Supported

Checked

Checked

Payment Card Token

See Payment Instruments

paymentcardtoken

List

Copy and Transform Not Supported

Checked

Checked

Payment Item

paymentitem

Item

Full

Checked

Checked

Payment Instruments

paymentcard, paymentcardtoken, generaltoken

List

Copy and Transform Not Supported

Checked

Checked

Payment Method

paymentmethod

List

Full

Checked

Checked

Payroll Batch

payroll batch

Transaction

Full

Checked

Checked

Payroll Batch Employee

payrollbatchaddemployees

Transaction

Read and Update Only

Checked

Checked

Payroll Item

payrollitem

List

Full

Checked

Checked

Performance Metric

performancemetric

List

Full

Checked

Checked

Performance Review

performancereview

List

Copy not supported

Checked

Checked

Performance Review Schedule

performancereviewschedule

List

Full

Checked

Checked

Period End Journal

periodendjournal

Transaction

Read, Search, limited Update

Checked

Checked

Phone Call

phonecall

Activity

Full

Checked

Checked

Pick Strategy

pickstrategy

Transaction

Full

Checked

Checked

Planned Order

plannedorder

Item

Copy and Transform Not Supported

Checked

Checked

Planning Item Category

planningitemcategory

Item

Transform Not Supported

Checked

Checked

Planning Item Group

planningitemgroup

Item

Transform Not Supported

Checked

Checked

Planning Rule Group

planningrulegroup

Item

Transform Not Supported

Checked

Checked

Price Book

pricebook

List

Full

Checked

Checked

Price Level

pricelevel

List

Search Not Supported

Checked

Checked

Price Plan

priceplan

List

Full

Checked

Checked

Pricing Group

pricinggroup

List

Full

Checked

Checked

Project

job

Entity

Full

Checked

Checked

Project Charge Rule

chargerule

List

Transform Not Supported

Checked

Checked

Project Expense Type

projectexpensetype

List

Full

Checked

Project Revenue Rule

laborbasedprojectrevenuerule

fixedamountprojectrevenuerule

pctcompleteprojectrevenuerule

List

Copy and Transform Not Supported

Checked

Checked

Project Status

jobstatus

Entity

Full

Checked

Checked

Project Task

projecttask

Event

Full

Checked

Checked

Project Template

projecttemplate

Entity

Copy Not Supported

Checked

Checked

Project Type

jobtype

Entity

Full

Checked

Checked

Project Work Breakdown Structure

wbs

List

Copy and Transform not supported

Checked

Checked

Promotion

promotioncode

Marketing

Full

Checked

Checked

Prospect

prospect

Entity

Full

Checked

Checked

Purchase Contract

purchasecontract

Transaction

Full

Checked

Checked

Purchase Order

purchaseorder

Transaction

Full

Checked

Checked

Reallocate Items

reallocateItem

Item

Exposed for user event scripts only.

This record can not be created, loaded, or deleted using scripts.

Requisition

purchaserequisition

Transaction

Full

Checked

Checked

Resource Allocation

resourceallocation

Activities

Full

Checked

Checked

Return Authorization

returnauthorization

Transaction

Full

Checked

Checked

Revenue Arrangement

revenuearrangement

Transaction

Full

Checked

Revenue Commitment

revenuecommitment

Transaction

Create Not Supported

See Usage Notes.

Checked

Checked

Revenue Commitment Reversal

revenuecommitmentreversal

Transaction

Create Not Supported

See Usage Notes.

Checked

Checked

Revenue Recognition Event

billingrevenueevent

List

Create, Red, Update, Delete, and Search

Checked

Checked

User Event Scripts Not Supported

Revenue Recognition Field Map

revrecfieldmapping

List

Full

Checked

Checked

Revenue Recognition Plan

revrecplan

List

Copy, Create, and Delete Not Supported

Checked

User Event Scripts Not Supported

Revenue Recognition Schedule

revrecschedule

List

Copy, Create, and Delete Not Supported

Checked
(User Event Scripts Not Supported)

Revenue Recognition Template

revrectemplate

List

Full

Checked
(User Event Scripts Not Supported)

Role

role

List

Search Only

Checked

Order Reservation

saleschannel

Transaction

Created, read, updated, deleted, copied, and searched.

It cannot be transformed.

Checked

Checked

Sales Order

salesorder

Transaction

Full

Checked

Checked

Sales Role

salesrole

List

Full

Checked

Checked

Sales Tax Item

salestaxitem

List

Full

Checked

Scheduled Script Instance

--

Customization

Search Only

Checked

Script

Note that this covers these script type records: Bundle Installation Script, Client Script, Map/Reduce Script, Mass Update Script, Portlet, Restlet, Suitelet, User Event Script, and Workflow Action Script.

Need Internal ID. See Script description

Customization

Copy, Create, and Delete Not Supported

See Usage Notes

Checked

Script Deployment

Need Internal ID. See Script Deployment description

Customization

See Usage Notes

Checked

Serialized Assembly Item

serializedassemblyitem

Item

Full

Checked

Checked

Serialized Inventory Item

serializedinventoryitem

Item

Full

Checked

Checked

Service

serviceitem

Item

Full

Checked

Checked

Shipping Item

shipitem

Item

Copy and Create Not Supported

Checked

Shopping Cart

shoppingcart

Website

Search Only

Checked

Solution

solution

Support

Full

Checked

Checked

Statistical Journal Entry

statisticaljournalentry

Transaction

Full

Checked

Checked

Store Pickup Fulfillment

storepickupfulfillment

Transaction

Copy and Create Not Supported

Checked

Checked

Subscription

subscription

Transaction

Full

Checked

Checked

Subscription Line

subscriptionline

Transaction

Create and Delete Not Supported

Checked

Checked

Subscription Plan

subscriptionplan

Item

Full

Checked

Checked

Subscription Term

subscriptionterm

Item

Copy, Create, Delete, Read, Search, and Update

Checked

Checked

Subsidiary

subsidiary

List

Full

Checked

Checked

Subsidiary Settings

subsidiarysettings

List

Read, Update, and Search

Search is available only through SuiteAnalytics Workbook.

Checked

Subtotal Item

subtotalitem

Item

Full

Checked

Checked

Supply Chain Snapshot

supplychainsnapshot

List

Read, Create, Edit, Delete, and Search

Checked

Checked

Supply Chain Snapshot Simulation

supplychainsnapshotsimulation

Item

Read, Create, Update, Delete, Search

Checked

Checked

Supply Change Order

supplychangeorder

Item

Create, Copy, and Transform Not Supported

Checked

Checked

Supply Plan Definition

supplyplandefinition

Item

Transform Not Supported

Checked

Checked

System Note

systemnote

(SYSTEM_NOTE for SuiteScript 2.0 search enum)

List

Search Only

Checked

Checked

Task

task

Activity

Full

Checked

Checked

Tax Control Account

taxacct

List

Delete and Search Not Supported

Checked

Checked

Tax Group

taxgroup

List

Full

Checked

Tax Period

taxperiod

List

Full

Checked

Tax Type

taxtype

List

Full

Checked

Term

term

List

Search Not Supported

Checked

Checked

Time

timebill

Transaction

Full

Checked

Checked

Time-Off Change

timeoffchange

Entity

Copy and Transform Not Supported

Checked

User Event Triggering not supported.

Time-Off Plan

timeoffplan

Entity

Copy and Transform Not Supported

Checked

User Event Triggering not supported.

Time-Off Request

timeoffrequest

Entity

Copy and Transform Not Supported

Checked

User Event Triggering not supported.

Time-Off Rule

timeoffrule

Entity

Copy and Transform Not Supported

Checked

User Event Triggering is not supported.

Time-Off Type

timeofftype

Entity

Copy and Transform Not Supported

Checked

User Event Triggering not supported.

Topic

topic

Support

Full

Checked

Transaction Search

transaction

Transaction

Search Only

Checked

Checked

Transfer Order

transferorder

Transaction

Full

Checked

Checked

Unit of Measure

unitstype

List

Full

Checked

Unlocked Time Period

unlockedtimeperiod

Transaction

Read, Create, Update, Delete, Copy, and Search

Checked

Checked

Usage

usage

Transaction

Full

Vendor

vendor

Entity

Full

Checked

Checked

Vendor Bill

vendorbill

Transaction

Full

Checked

Checked

Vendor Category

vendorcategory

List

Search Not Supported

Checked

Checked

Vendor Credit

vendorcredit

Transaction

Full

Checked

Checked

Vendor Payment

vendorpayment

Transaction

Full

Checked

Checked

Vendor Prepayment

vendoreprepayment

Transaction

Read, Create, Update, Delete, and Search

Checked

Checked

Vendor Prepayment Application

vendoreprepaymentapplication

Transaction

Read, Transform, Update, Delete, and Search

Checked

Checked

Vendor Return Authorization

vendorreturnauthorization

Transaction

Full

Checked

Checked

Vendor-Subsidiary Relationship

vendorsubsidiaryrelationship

List

Full

Checked

Checked

Wave

wave

Transaction

Read, Create, Update, Delete, and Search

Checked

Checked

Website Setup

website

Website

Full

Checked

Not supported in beforeLoad user event scripts.

Weekly Timesheet

timesheet

Transaction

Full

Checked

Checked

Work Order

workorder

Transaction

Full

Checked

Checked

Work Order Close

workorderclose

Transaction

Copy and Create Not Supported.

Checked

Work Order Completion

workordercompletion

Transaction

Copy and Create Not Supported

Checked

Work Order Issue

workorderissue

Transaction

Copy and Create Not Supported

Checked

Workplace

workplace

List

Full

Checked

Checked

Zone

zone

List

Full

Checked

Checked

Related Topics

Working with the SuiteScript Records Browser

General Notices