NetSuite generic Entity used as a common base class for 'entity-like' records, This is meant to be inherited by concrete record types to avoid duplicating effort on fields. Note that this inheritance hierarchy emerged empirically - it's not documented by NetSuite.

It contains fields common to all 'entity' records in NS

Hierarchy

Constructors

  • Loads an existing record with the given internal id

    Example

    // load customer with internal id 123
    const c = new Customer(123)

    Parameters

    • id: NonNullable<string | number>

      record internal id to load

    • Optional isDynamic: boolean

      set true if you want to load the record in dynamic mode

    Returns Entity

  • Creates an NSDAL instance for the given existing NetSuite record object. This does NOT reload the record - it just wraps the supplied rec

    Example

    // assume `ctx` is the _context_ object passed to a `beforeSubmit()` entrypoint.
    // results in an NFT representation of the 'new record'
    const customer = new Customer(ctx.newRecord)

    Parameters

    • rec: NonNullable<ClientCurrentRecord | Record>

      an existing netsuite record

    Returns Entity

  • creates a new record

    Example

    // start a new customer record
    const c = new Customer()

    // start a new customer record in dynamic mode
    const c = new Customer(null, true)

    Parameters

    • Optional unused: Nullable<string | number>

      either null or leave this parameter out entirely

    • Optional isDynamic: boolean

      true if you want to create the record in dynamic mode, otherwise uses standard mode.

    • Optional defaultvalues: object

      optional defaultvalues object - specific to certain records that allow initializing a new record.

    Returns Entity

Properties

_id: number

Netsuite internal id of this record

accountnumber: string
altemail: string
altphone: string
balance: number
billpay: boolean
category: number
comments: string
companyname: string
currency: number
customform: number
datecreated: Date
defaultValues?: object
email: string
entityid: string
entitystatus: number
externalid: string
fax: string
firstname: string
isinactive: boolean
isperson: null | "T" | "F"
language: number
lastmodifieddate: Date
lastname: string
nsrecord: Record

underlying netsuite record

parent: number
phone: string
subsidiary: number
taxitem: number
terms: number

Accessors

  • get id(): number
  • Returns number

Methods

  • Persists this record to the NS database

    Returns

    Parameters

    • Optional enableSourcing: boolean
    • Optional ignoreMandatoryFields: boolean

    Returns number

  • The netsuite record type (constant string) - this is declared here and overridden in derived classes

    Returns string | Type

Generated using TypeDoc