The content in this help topic pertains to SuiteScript 2.0.

Object Description

Encapsulates a file within NetSuite.


This object only encapsulates a file’s metadata. Content is only loaded into memory (and returned as a string) when you call the File.getContents(). Content from CSV or text files can be accessed line by line using File.appendLine(options) or File.lines.iterator().


Binary content must be base64 encoded.

Create a new file.File Object (up to 10MB in size) with the file.create(options) method.

After you create a new file.File, you can:

  • upload it to the NetSuite File Cabinet with the method.

  • attach it to an email or fax without saving it to the File Cabinet.


If you want to save the file to the NetSuite File Cabinet, you must set a NetSuite File Cabinet folder with the File.folder property. You must do this before you call

Returns reader object File.getReader() and iterator of segments File.getSegments(options).

For a complete list of this object’s methods and properties, see File Object Members.

Supported Script Types

Server scripts

For more information, see SuiteScript 2.x Script Types.


N/file Module




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

          //Add additional code 
var fileObj = file.create({
    name: 'test.txt',
    fileType: file.Type.PLAINTEXT,
    contents: 'Hello World\nHello World'
fileObj.folder = 30;
var fileId =;

//Add additional code 


Related Topics

N/file Module
SuiteScript 2.x Modules
SuiteScript 2.x

General Notices