record.transform(options)

Method Description	Transforms a record from one type into another, using data from an existing record. You can use this method to automate order processing, creating item fulfillment transactions and invoices off of orders. For a list of supported transformations, see Supported Transformation Types. Note: For the promise version of this method, see record.transform.promise(options). Note that promises are only supported in client scripts.
Returns	record.Record
Supported Script Types	Client and server scripts For more information, see SuiteScript 2.x Script Types.
Governance	Transaction records: 10 units Custom records: 2 units All other record types: 5 units
Module	N/record Module
Since	2015.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description	Since
options.fromType	string	required	The record type of the existing record instance being transformed. This value sets the Record.type property for the record. This property is read-only and cannot be changed after the record is loaded. Set this value using the record.Type.	2015.2
options.fromId	number	required	The internal ID of the existing record instance being transformed.	2015.2
options.toType	string	required	The record type of the record returned when the transformation is complete.	2015.2
options.isDynamic	boolean	optional	Determines whether the new record is created in dynamic mode. If set to true, the new record is created in dynamic mode. If set to false, the new record is created in standard mode. By default, this value is false. Note: For additional information about standard and dynamic mode, see record.Record and SuiteScript 2.x Standard and Dynamic Modes.	2015.2
options.defaultValues	Object	optional	Name-value pairs containing default values of fields in the new record. By default, this value is null. For a list of available record default values, see N/record Default Values in the NetSuite Help Center.	2015.2

Errors

Error Code	Thrown If
SSS_MISSING_REQD_ARGUMENT	A required argument is missing or undefined.

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/record Module Script Samples.

          // Add additional code
...
var objRecord = record.transform({
    fromType: record.Type.CUSTOMER,
    fromId: 107,
    toType: record.Type.SALES_ORDER,
    isDynamic: true,
});
...
// Add additional code 

        

          // Add additional code
...
record.transform({ 
   fromType:'salesorder', 
   fromId: 6, 
   toType: 'invoice', 
   defaultValues: {
   billdate: '01/01/2019'} });
...
// Add additional code 

        

Supported Transformation Types

Original Record Name	Original Record Type	Transformed Record Name	Transformed Record Type
Assembly Build	assemblybuild	Assembly Unbuild	assemblyunbuild
Build/Assembly	assemblyitem	Assembly Build Note: You cannot use SuiteScript to create an Assembly Build for an Outsourcing Work Order.	assemblybuild
Build/Assembly	assemblyitem	Work Order	workorder
Cash Refund	cashrefund	Credit Memo	creditmemo
Cash Sale	cashsale	Cash Refund	cashrefund
Cash Sale	cashsale	Custom Sales Transaction	customsalestransaction
Cash Sale	cashsale	Return Authorization	returnauthorization
Customer	customer	Cash Sale	cashsale
Customer	customer	Customer Payment Note: When you use this transformation, do not use Record.setValue(options) to set the value of the customer field on the resulting Customer Payment record. This field is populated automatically during transformation, and you cannot specify a value for this field after the transformation is complete.	customerpayment
Customer	customer	Estimate	estimate
Customer	customer	Invoice	invoice
Customer	customer	Opportunity	opportunity
Customer	customer	Sales Order	salesorder
Customer	customer	Vendor	vendor
Customer Deposit	customerdeposit	Customer Refund	customerrefund
Customer Deposit	customerdeposit	Deposit Application	depositapplication
Customer Payment	customerpayment	Customer Refund	customerrefund
Customer Payment Authorization	customerpaymentauthorization	Customer Deposit	customerdeposit
Customer Payment Authorization	customerpaymentauthorization	Customer Payment	customerpayment
Custom Purchase Transaction	custompurchasetransaction	Custom Purchase Transaction	custompurchasetransaction
Custom Purchase Transaction	custompurchasetransaction	Vendor Bill	vendorbill
Custom Purchase Transaction	custompurchasetransaction	Vendor Credit	vendorcredit
Custom Purchase Transaction	custompurchasetransaction	Vendor Payment	vendorpayment
Custom Sales Transaction	customsalestransaction	Cash Refund	cashrefund
Custom Sales Transaction	customsalestransaction	Customer Payment	customerpayment
Custom Sales Transaction	customsalestransaction	Customer Refund	customerrefund
Custom Sales Transaction	customsalestransaction	Invoice	invoice
Custom Sale Transaction	customsaletransaction	Cash Sale	cashsale
Custom Sale Transaction	customsaletransaction	Credit Memo	creditmemo
Custom Sale Transaction	customsaletransaction	Custom Sale Transaction	customsaletransaction
Employee	employee	Expense Report	expensereport
Employee	employee	Time	timebill
Quote	estimate	Cash Sale	cashsale
Quote	estimate	Invoice	invoice
Quote	estimate	Sales Order	salesorder
Intercompany Transfer Order	intercompanytransferorder	Item Fulfillment	itemfulfillment
Intercompany Transfer Order	intercompanytransferorder	Item Receipt	itemreceipt
Invoice	invoice	Credit Memo	creditmemo
Invoice	invoice	Customer Payment	customerpayment
Invoice	invoice	Custom Sales Transaction	customsalestransaction
Invoice	invoice	Return Authorization	returnauthorization
Job	job	Cash Sale	cashsale
Job	job	Estimate	estimate
Job	job	Invoice	invoice
Job	job	Sales Order	salesorder
Lead	lead	Opportunity	opportunity
Opportunity	opportunity	Cash Sale	cashsale
Opportunity	opportunity	Quote	estimate
Opportunity	opportunity	Invoice	invoice
Opportunity	opportunity	Sales Order	salesorder
Prospect	prospect	Quote	estimate
Prospect	prospect	Opportunity	opportunity
Prospect	prospect	Sales Order	salesorder
Purchase Order	purchaseorder	Custom Purchase Transaction	custompurchasetransaction
Purchase Order	purchaseorder	Item Receipt Note: This transformation does not work for Drop Ship Purchase Order.	itemreceipt
Purchase Order	purchaseorder	Ownership Transfer	ownershiptransfer
Purchase Order	purchaseorder	Vendor Bill	vendorbill
Purchase Order	purchaseorder	Vendor Return Authorization	vendorreturnauthorization
Purchase Requisition	purchaserequisition	Purchase Order	purchaseorder
Request For Quote	requestforquote	Vendor Request For Quote	vendorrequestforquote
Return Authorization	returnauthorization	Cash Refund	cashrefund
Return Authorization	returnauthorization	Credit Memo	creditmemo
Return Authorization	returnauthorization	Custom Sales Transaction	customsalestransaction
Return Authorization	returnauthorization	Item Receipt	itemreceipt
Return Authorization	returnauthorization	Revenue Commitment Reversal Note: The return authorization must be approved and received for this transformation to work.	revenuecommitmentreversal
Revenue Contract	revenuecontract	Revenue Commitment	revenuecommitment
Sales Order	salesorder	Cash Sale	cashsale
Sales Order	salesorder	Custom Sales Transaction	customsalestransaction
Sales Order	salesorder	Fulfillment Request	fulfillmentrequest
Sales Order	salesorder	Invoice	invoice
Sales Order	salesorder	Item Fulfillment	itemfulfillment
Sales Order	salesorder	Return Authorization	returnauthorization
Sales Order	salesorder	Revenue Commitment	revenuecommitment
Sales Order	salesorder	Revenue Contract	revenuecontract
Sales Order	salesorder	Store Pickup Fulfillment	storepickupfulfillment
Transfer Order	transferorder	Item Fulfillment	itemfulfillment
Transfer Order	transferorder	Item Receipt	itemreceipt
Vendor	vendor	Customer	customer
Vendor	vendor	Purchase Order	purchaseorder
Vendor	vendor	Vendor Bill	vendorbill
Vendor	vendor	Vendor Payment	vendorpayment
Vendor Bill	vendorbill	Custom Purchase Transaction	custompurchasetransaction
Vendor Bill	vendorbill	Vendor Credit	vendorcredit
Vendor Bill	vendorbill	Vendor Payment	vendorpayment
Vendor Bill	vendorbill	Vendor Return Authorization	vendorreturnauthorization
Vendor Prepayment	vendorprepayment	Vendor Prepayment Application	vendorprepaymentapplication
Vendor Request For Quote	vendorrequestforquote	Purchase Contract	purchasecontract
Vendor Return Authorization	vendorreturnauthorization	Custom Purchase Transaction	custompurchasetransaction
Vendor Return Authorization	vendorreturnauthorization	Item Fulfillment	itemfulfillment
Vendor Return Authorization	vendorreturnauthorization	Vendor Credit	vendorcredit
Work Order	workorder	Assembly Build	assemblybuild
Work Order	workorder	Work Order Close	workorderclose
Work Order	workorder	Work Order Completion	workordercompletion
Work Order	workorder	Work Order Issue	workorderissue

Related Topics

• N/record Module
• SuiteScript 2.x Modules
• SuiteScript 2.x

General Notices