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:

• clickable record names, which take you to detailed information about the record

• record IDs, which are often referenced in SuiteScript APIs

• scripting levels (where Full scripting level means that the record can be created, updated, copied, deleted, and searched)

• SuiteScript client or server support

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:

• Working with the SuiteScript Records Browser

• How to Use SuiteScript Records Help

Record Name	Record ID	Record Category	Scripting Level	Scriptable in Client SuiteScript	Scriptable in Server SuiteScript
Account	account	List	Full	—
Accounting Book	accountingbook	List	Copy Not Supported	—
Accounting Context	accountingcontext	List	Read, Create, Update, Copy, Delete, and Search
Accounting Period	accountingperiod	List	Read and Search Only
Activity	activity	Activity	Search Only
Address See Subrecord Scripting Overview.	addressbookaddress	Subrecord	See About the Address Subrecord.		Server scripts must access through the parent record.
Advanced Intercompany Journal Entry	advintercompanyjournalentry	Transaction	Full
Allocation Schedule	allocationschedule	List	Create, Read, Update, and Delete
Amortization Schedule	amortizationschedule	List	Copy, Create, and Delete Not Allowed	—
Amortization Template	amortizationtemplate	List	Full	—
As Charged Project Revenue Rule	aschargedprojectrevenuerule	Entities	Full
Assembly Build	assemblybuild	Transaction	Full	—
Assembly Item	assemblyitem	Item	Full	—
Assembly Unbuild	assemblyunbuild	Transaction	Full	—
Automated Clearing House	automatedclearinghouse	List	Copy and Transform Not Supported.
Balance Transactions by Segments	balancetrxbysegments	Transaction	Create, Read, and Search	—
Billing Account	billlingaccount	List	Full
Billing Class	billingclass	List	Full
Billing Rate Card	billingratecard	List	Read, Create, Update, Delete, and Search Copy and Transform Not Supported
Billing Schedule	billingschedule	List	Full	—
Bin	bin	List	Full	—
Bin Putaway Worksheet	binworksheet	Transaction	Copy and Update Not Supported	—	Dynamic Mode Only
Bin Transfer	bintransfer	Transaction	Full	—
Blanket Purchase Order	blanketpurchaseorder	Transaction	Full
BOM	bom	List	Read, Create, Update, Copy, Delete, and Search
BOM Revision	bomrevision	List	Read, Create, Update, Copy, Delete, and Search	—
Bonus	bonus	Entity	Read, Create, Update, Copy, Delete, and Search
Bonus Type	bonustype	Entity	Read, Create, Update, Copy, Delete, and Search
Budget Exchange Rate	budgetexchangerate	List	Read, Update, and Search
Campaign	campaign	Marketing	Full
Campaign Response	campaignresponse	Marketing	Full
Campaign Template	campaigntemplate	Marketing	Search Not Supported	—
Case	supportcase	Support	Full
Cash Refund	cashrefund	Transaction	Full
Cash Sale	cashsale	Transaction	Full
Change Order	subscriptionchangeorder	Transaction	Full
Charge	charge	Transaction	Full	—
Check	check	Transaction	Full
Class	classification	List	Server SuiteScript Only	—
CMS Content	cmscontent	Web Site	Create, Update, and Search Only Attach, Transform, and Copy Not Supported	—
CMS Content Type	cmscontenttype	Web Site	Create, Update, and Search Only Attach, Transform, and Copy Not Supported	—
CMS Page	cmspage	Web Site	Create, Update, and Search Only Attach, Transform, and Copy Not Supported	—
Commerce Category	commercecategory	Website	Attach, Transform, and Copy Not Supported	—
Competitor	competitor	Entity	Full
Consolidated Exchange Rate	consolidatedexchangerate	List	Read, Update, and Search Only Create and Delete Not Supported
Contact	contact	Entity	Full
Contact Category	contactcategory	List	Full
Contact Role	contactrole	List	Full
Cost Category	costcategory	List	Full
Coupon Code	couponcode	Marketing	Full
Credit Card Charge	creditcardcharge	Transaction	Full	—
Credit Card Refund	creditcardrefund	Transaction	Full	—
Credit Memo	creditmemo	Transaction	Full
Currency	currency	List	Full — with Multiple Currencies Feature Enabled Read Only — without Multiple Currencies Feature	—
Currency Rate	currencyrate	List	Create, Read, Copy, and Search Only
Custom List	See Custom List IDs	Custom	Search Only
Custom Record	See Custom Record IDs	Custom	Full
Customer	customer	Entity	Full
Customer Category	customercategory	List	Search Not Supported
Customer Deposit	customerdeposit	Transaction	Full
Customer Message	customermessage	List	Full
Customer Payment	customerpayment	Transaction	Copy and Create Not Allowed	—
Customer Refund	customerrefund	Transaction	Full	—
Customer Status	customerstatus	Entity	Full
Customer-Subsidiary Relationship	customersubsidiaryrelationship	List	Full
Department	department	List	Server SuiteScript Only	—
Deposit	deposit	Transaction	Copy Not Supported Dynamic Mode Not Supported
Deposit Application	depositapplication	Transaction	Create Not Allowed
Description Item	descriptionitem	Item	Full
Discount Item	discountitem	Item	Full
Download Item	downloaditem	Item	Full
Driver’s License	driverslicense	List	Full		User event scripts are not supported.
Email Template	emailtemplate	Marketing	Search Not Supported	—
Employee	employee	Entity	Full
Employee Change Request	employeechangerequest	List	Copy and Transform Not Supported
Employee Change Request Type	employeechangerequesttype	List	Copy and Transform Not Supported
Employee Expense Source Type	employeeexpensesourcetype	Transaction	Full
Employee Status	employeestatus	Entity	Transform Not Supported
Employee Type	employeetype	Entity	Transform Not Supported
Entity	entity	Entity	Search Only	—	—
Estimate	estimate	Transaction	Full
Event	calendarevent	Activity	Full
Expense Category	expensecategory	List	Full	—
Expense Report	expensereport	Transaction	Full
Expense Report Policy	expensereportpolicy	Transaction	Read, create, update, copy, delete, and search.
Fair Value Price	fairvaluepricelist	List	Create, Delete, and Search Only Copy Not Allowed	—
File	file	File Cabinet	Search Only	—
Financial Institution	financialinstitution	List	Read, Create, Update, Delete, and Search	—
Folder	folder	File Cabinet	Full	—	beforeLoad event is not supported on user event scripts.
Format Profile	formatprofile	List	Read, Create, Update, and Delete
Fulfillment Request	fulfillmentrequest	Transaction	Create and Copy Not Supported
General Token See Payment Instruments	generaltoken	List	Copy and Transform Not Supported
Generic Resource	genericresource	Entity	Copy Not Supported
Gift Certificate	giftcertificate	List	Full
Gift Certificate Item	giftcertificateitem	Item	Full
GL Audit Numbering Sequence	glnumberingsequence	Transaction	Read, Create, Update, Copy, Search
Global Account Mapping	globalaccountmapping	List	Full	—
Global Inventory Relationship	globalinventoryrelationship	List	Read, Create, Edit, Delete, Search Copy Not Supported
Goal	goal	List	Full
Group	entitygroup	List	Full	—
Imported Employee Expense	importedemployeeexpense	Transaction	Full
Inbound Shipment	inboundshipment	List	Copy and Transform Not Supported
Intercompany Allocation Schedule	intercompallocationschedule	List	Create, Read, Update, and Delete
Intercompany Journal Entry	intercompanyjournalentry	Transaction	Full
Intercompany Transfer Order	intercompanytransferorder	Transaction	Full
Inventory Adjustment	inventoryadjustment	Transaction	Full
Inventory Cost Revaluation	inventorycostrevaluation	Transaction	Full
Inventory Count	inventorycount	Transaction	Full
Inventory Detail	inventorydetail	Subrecord	See Creating an Inventory Detail Sublist Subrecord Example.		Server scripts must access through the parent record
Inventory Item (Also referred to in the UI as Inventory Part)	inventoryitem	Item	Full
Inventory Number	inventorynumber	List	Copy, Create, and Delete Not Supported	—
Inventory Status	inventorystatus	List	Full
Inventory Status Change	inventorystatuschange	Transaction	Full
Inventory Transfer	inventorytransfer	Transaction	Full	—
Invoice	invoice	Transaction	Full
Issue	issue	Support	Full
Issue Product	issueproduct	Support	Copy, transform and search not supported.
Issue Product Version	productversion	Support	Copy, transform and search not supported.
Item Account Mapping	itemaccountmapping	List	Full	—
Item Collection	itemcollection	List	Copy and Transform Not Supported
Item Collection Item Map	itemcollectionmap	List	Update, Copy, and Transform Not Supported
Item Demand Plan	itemdemandplan	Transaction	Copy Not Supported, No Available Transforms
Item Fulfillment	itemfulfillment	Transaction	Copy and Create Not Supported
Item Group	itemgroup	Item	Full
Item Location Configuration	itemlocationconfiguration	List	Read, Create, Edit, Delete, and Search	—
Item Process Family	itemprocessfamily	List	Full
Item Process Group	itemprocessgroup	List	Full
Item Receipt	itemreceipt	Transaction	Copy and Create Not Supported
Item Revision	itemrevision	List	Full	—
Item Search	item	Item	Search Only	—	—
Item Supply Plan	itemsupplyplan	Transaction	Full
Job	job	Entity	Copy and Transform Not Supported
Job Requisition	jobrequisition	Entity	Copy and Transform Not Supported
Journal Entry	journalentry	Transaction	Full
Kit Item	kititem	Item	Full	—
Kudos Feature Records	kudos	List	Full Only the inactive field can be edited.	—
Landed Cost	landedcost	Transaction	Full	—
Lead	lead	Entity	Full
Location	location	List	Server SuiteScript Only	—
Lot Numbered Assembly Item	lotnumberedassemblyitem	Item	Full
Lot Numbered Inventory Item	lotnumberedinventoryitem	Item	Full
Manufacturing Cost Template	manufacturingcosttemplate	List	Full	—
Manufacturing Operation Task	manufacturingoperationtask	Transaction	Copy Not Supported
Manufacturing Planned Time	mfgplannedtime	Transaction	Search Only
Manufacturing Routing	manufacturingrouting	List	Full	—
Markup Item	markupitem	Item	Full
Memorized Transaction Definition	memdoc	Transaction	Read, Update, Delete, and Search
Merchandise Hierarchy Level	merchandisehierarchylevel	List	Read, Create, Edit, Delete, and Search	—
Merchandise Hierarchy Node	merchandisehierarchynode	List	Read, Create, Edit, Delete, and Search	—
Merchandise Hierarchy Version	merchandisehierarchyversion	List	Read, Create, Edit, Delete, and Search	—
Message	message	Communication	For details, see Message.	—
Multi-Book Accounting Transaction	accountingtransaction	Transaction	Search Only
Nexus	nexus	List	Copy Not Supported	—
Non-Inventory Part	noninventoryitem	Item	Full
Note	note	Communication	Full	—
Note Type	notetype	List	Full
Opportunity	opportunity	Transaction	Full
Order Reservation	orderreservation	Transaction	Created, read, updated, deleted, copied, and searched. It cannot be transformed
Order Schedule	orderschedule	Transaction	See Subrecord Scripting Overview.		Server scripts must access through the parent record
Order Type	ordertype	List	Full
Organization Value	organizationvlaue	List	Full	—
Other Charge Item	otherchargeitem	Item	Full	—	—
Other Government-Issued ID	othergovernmentissuedid	List	Full		User event scripts are not supported.
Other Name	othername	Entity	Full	—
Other Name Category	othernamecategory	List	Full
Partner	partner	Entity	Full
Partner Category	partnercategory	List	Full
Passport	passport	List	Full		User event scripts are not supported.
Paycheck	paycheck	Transaction	Read and Update Only
Paycheck Journal	paycheckjournal	Transaction	Full
Payment Card See Payment Instruments	paymentcard	List	Copy and Transform Not Supported
Payment Card Token See Payment Instruments	paymentcardtoken	List	Copy and Transform Not Supported
Payment Item	paymentitem	Item	Full
Payment Instruments	paymentcard, paymentcardtoken, generaltoken	List	Copy and Transform Not Supported
Payment Method	paymentmethod	List	Full
Payroll Batch	payroll batch	Transaction	Full
Payroll Batch Employee	payrollbatchaddemployees	Transaction	Read and Update Only
Payroll Item	payrollitem	List	Full
Performance Metric	performancemetric	List	Full
Performance Review	performancereview	List	Copy not supported
Performance Review Schedule	performancereviewschedule	List	Full
Period End Journal	periodendjournal	Transaction	Read, Search, limited Update
Phone Call	phonecall	Activity	Full
Pick Strategy	pickstrategy	Transaction	Full
Pick Task	picktask	Transaction	Update, Delete and Search Supported Create and Copy Not Supported
Planned Order	plannedorder	Item	Copy and Transform Not Supported
Planning Item Category	planningitemcategory	Item	Transform Not Supported
Planning Item Group	planningitemgroup	Item	Transform Not Supported
Planning Rule Group	planningrulegroup	Item	Transform Not Supported
Price Book	pricebook	List	Full
Price Level	pricelevel	List	Search Not Supported
Price Plan	priceplan	List	Full
Pricing Group	pricinggroup	List	Full
Project	job	Entity	Full
Project Charge Rule	chargerule	List	Transform Not Supported
Project Expense Type	projectexpensetype	List	Full	—
Project Revenue Rule	laborbasedprojectrevenuerule fixedamountprojectrevenuerule pctcompleteprojectrevenuerule	List	Copy and Transform Not Supported
Project Status	jobstatus	Entity	Full
Project Task	projecttask	Event	Full
Project Template	projecttemplate	Entity	Copy Not Supported
Project Type	jobtype	Entity	Full
Project Work Breakdown Structure	wbs	List	Copy and Transform not supported
Promotion	promotioncode	Marketing	Full
Prospect	prospect	Entity	Full
Purchase Contract	purchasecontract	Transaction	Full
Purchase Order	purchaseorder	Transaction	Full
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
Resource Allocation	resourceallocation	Activities	Full
Resource Group	resourcegroup	Transaction	Full
Return Authorization	returnauthorization	Transaction	Full
Revenue Arrangement	revenuearrangement	Transaction	Full	—
Revenue Commitment	revenuecommitment	Transaction	Create Not Supported See Usage Notes.
Revenue Commitment Reversal	revenuecommitmentreversal	Transaction	Create Not Supported See Usage Notes.
Revenue Recognition Event	billingrevenueevent	List	Create, Red, Update, Delete, and Search		User Event Scripts Not Supported
Revenue Recognition Field Map	revrecfieldmapping	List	Full
Revenue Recognition Plan	revrecplan	List	Copy, Create, and Delete Not Supported	—	User Event Scripts Not Supported
Revenue Recognition Schedule	revrecschedule	List	Copy, Create, and Delete Not Supported	—	(User Event Scripts Not Supported)
Revenue Recognition Template	revrectemplate	List	Full	—	(User Event Scripts Not Supported)
Role	role	List	Search Only	—
Order Reservation	saleschannel	Transaction	Created, read, updated, deleted, copied, and searched. It cannot be transformed.
Sales Order	salesorder	Transaction	Full
Sales Role	salesrole	List	Full
Sales Tax Item	salestaxitem	List	Full	—
Scheduled Script Instance	--	Customization	Search Only	—
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	—
Script Deployment	Need Internal ID. See Script Deployment description	Customization	See Usage Notes	—
Serialized Assembly Item	serializedassemblyitem	Item	Full
Serialized Inventory Item	serializedinventoryitem	Item	Full
Service	serviceitem	Item	Full
Shipping Item	shipitem	Item	Copy and Create Not Supported	—
Shopping Cart	shoppingcart	Website	Search Only	—
Solution	solution	Support	Full
Statistical Journal Entry	statisticaljournalentry	Transaction	Full
Store Pickup Fulfillment	storepickupfulfillment	Transaction	Copy and Create Not Supported
Subscription	subscription	Transaction	Full
Subscription Line	subscriptionline	Transaction	Create and Delete Not Supported
Subscription Plan	subscriptionplan	Item	Full
Subscription Term	subscriptionterm	Item	Copy, Create, Delete, Read, Search, and Update
Subsidiary	subsidiary	List	Full
Subsidiary Settings	subsidiarysettings	List	Read, Update, and Search Search is available only through SuiteAnalytics Workbook.	—
Subtotal Item	subtotalitem	Item	Full
Supply Chain Snapshot	supplychainsnapshot	List	Read, Create, Edit, Delete, and Search
Supply Chain Snapshot Simulation	supplychainsnapshotsimulation	Item	Read, Create, Update, Delete, Search
Supply Change Order	supplychangeorder	Item	Create, Copy, and Transform Not Supported
Supply Plan Definition	supplyplandefinition	Item	Transform Not Supported
System Note	systemnote (SYSTEM_NOTE for SuiteScript 2.0 search enum)	List	Search Only
Task	task	Activity	Full
Tax Control Account	taxacct	List	Delete and Search Not Supported
Tax Group	taxgroup	List	Full	—
Tax Period	taxperiod	List	Full	—
Tax Type	taxtype	List	Full	—
Term	term	List	Search Not Supported
Time	timebill	Transaction	Full
Time-Off Change	timeoffchange	Entity	Copy and Transform Not Supported	—	User Event Triggering not supported.
Time-Off Plan	timeoffplan	Entity	Copy and Transform Not Supported	—	User Event Triggering not supported.
Time-Off Request	timeoffrequest	Entity	Copy and Transform Not Supported	—	User Event Triggering not supported.
Time-Off Rule	timeoffrule	Entity	Copy and Transform Not Supported	—	User Event Triggering is not supported.
Time-Off Type	timeofftype	Entity	Copy and Transform Not Supported	—	User Event Triggering not supported.
Topic	topic	Support	Full	—
Transaction Search	transaction	Transaction	Search Only
Transfer Order	transferorder	Transaction	Full
Unit of Measure	unitstype	List	Full	—
Unlocked Time Period	unlockedtimeperiod	Transaction	Read, Create, Update, Delete, Copy, and Search
Usage	usage	Transaction	Full	—	—
Vendor	vendor	Entity	Full
Vendor Bill	vendorbill	Transaction	Full
Vendor Category	vendorcategory	List	Search Not Supported
Vendor Credit	vendorcredit	Transaction	Full
Vendor Payment	vendorpayment	Transaction	Full
Vendor Prepayment	vendoreprepayment	Transaction	Read, Create, Update, Delete, and Search
Vendor Prepayment Application	vendoreprepaymentapplication	Transaction	Read, Transform, Update, Delete, and Search
Vendor Return Authorization	vendorreturnauthorization	Transaction	Full
Vendor-Subsidiary Relationship	vendorsubsidiaryrelationship	List	Full
Wave	wave	Transaction	Read, Create, Update, Delete, and Search
Website Setup	website	Website	Full	—	Not supported in beforeLoad user event scripts.
Weekly Timesheet	timesheet	Transaction	Full
Work Order	workorder	Transaction	Full
Work Order Close	workorderclose	Transaction	Copy and Create Not Supported.	—
Work Order Completion	workordercompletion	Transaction	Copy and Create Not Supported	—
Work Order Issue	workorderissue	Transaction	Copy and Create Not Supported	—
Workplace	workplace	List	Full
Zone	zone	List	Full

Related Topics

• Working with the SuiteScript Records Browser

General Notices