Class LeadBase

Lead record in NetSuite

Hierarchy (view full)

Constructors

constructor

Properties

_id accessrole accountnumber addressbook altemail altphone autoname balance billpay buyingreason buyingtimeframe category comments companyname consoldaysoverdue contactroles creditholdoverride currency currencyprecision customform datecreated daysoverdue defaultValues? defaultbankaccount download draccount email emailtransactions entityid entitystatus estimatedbudget externalid fax firstname fxaccount globalsubscriptionstatus grouppricing image isbudgetapproved isinactive isperson itempricing keywords language lastmodifieddate lastname lastvisit leadsource middlename negativenumberformat nsrecord numberformat parent partner partners phone prefccprocessor pricelevel printoncheckas printtransactions receivablesaccount referrer resalenumber salesgroup salesreadiness salesrep salesteam sourcewebsite stage subsidiary syncpartnerteams syncsalesteams taxable taxexempt taxfractionunit taxitem taxrounding terms territory title unsubscribe visits weblead

Accessors

id

Methods

getField save toJSON recordType

Constructors

constructor

  • new LeadBase(id, isDynamic?): LeadBase

  • Loads an existing record with the given internal id

    Parameters

    • id: NonNullable<string | number>

      record internal id to load

    • OptionalisDynamic: boolean

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

    Returns LeadBase

    Example

    // load customer with internal id 123
    const c = new Customer(123)
  • new LeadBase(rec): LeadBase

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

    Parameters

    • rec: NonNullable<ClientCurrentRecord | Record>

      an existing netsuite record

    Returns LeadBase

    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)
  • new LeadBase(unused?, isDynamic?, defaultvalues?): LeadBase

  • creates a new record

    Parameters

    • Optionalunused: Nullable<string | number>

      either null or leave this parameter out entirely

    • OptionalisDynamic: boolean

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

    • Optionaldefaultvalues: object

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

    Returns LeadBase

    Example

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

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

Properties

Protected_id

_id: number

Netsuite internal id of this record

accessrole

accessrole: number

accountnumber

accountnumber: string

addressbook

addressbook: Sublist<AddressSublist>

altemail

altemail: string

altphone

altphone: string

autoname

autoname: boolean

balance

balance: number

billpay

billpay: boolean

buyingreason

buyingreason: number

buyingtimeframe

buyingtimeframe: boolean

category

category: number

comments

comments: string

companyname

companyname: string

consoldaysoverdue

consoldaysoverdue: number

contactroles

contactroles: Sublist<ContactsSublist>

creditholdoverride

creditholdoverride: number

currency

currency: number

currencyprecision

currencyprecision: string

customform

customform: number

datecreated

datecreated: Date

daysoverdue

daysoverdue: number

Protected OptionaldefaultValues

defaultValues?: object

defaultbankaccount

defaultbankaccount: number

download

download: Sublist<DownloadsSublist>

draccount

draccount: number

email

email: string

emailtransactions

emailtransactions: boolean

entityid

entityid: string

entitystatus

entitystatus: number

estimatedbudget

estimatedbudget: number

externalid

externalid: string

fax

fax: string

firstname

firstname: string

fxaccount

fxaccount: number

globalsubscriptionstatus

globalsubscriptionstatus: number

grouppricing

grouppricing: Sublist<GroupPricingSublist>

image

image: number

isbudgetapproved

isbudgetapproved: boolean

isinactive

isinactive: boolean

isperson

isperson: null | "T" | "F"

itempricing

itempricing: Sublist<ItemPricingSublist>

keywords

keywords: string

language

language: number

lastmodifieddate

lastmodifieddate: Date

lastname

lastname: string

lastvisit

lastvisit: string

leadsource

leadsource: number

middlename

middlename: string

negativenumberformat

negativenumberformat: number

nsrecord

nsrecord: Record

underlying netsuite record

numberformat

numberformat: number

parent

parent: number

partner

partner: number

partners

partners: Sublist<PartnersSublist>

phone

phone: string

prefccprocessor

prefccprocessor: number

pricelevel

pricelevel: number

printoncheckas

printoncheckas: string

printtransactions

printtransactions: boolean

receivablesaccount

receivablesaccount: number

referrer

referrer: string

resalenumber

resalenumber: string

salesgroup

salesgroup: number

salesreadiness

salesreadiness: number

salesrep

salesrep: number

salesteam

salesteam: Sublist<SalesTeamSublist>

sourcewebsite

sourcewebsite: number

stage

stage: string

subsidiary

subsidiary: number

syncpartnerteams

syncpartnerteams: boolean

syncsalesteams

syncsalesteams: boolean

taxable

taxable: boolean

taxexempt

taxexempt: boolean

taxfractionunit

taxfractionunit: number

taxitem

taxitem: number

taxrounding

taxrounding: number

terms

terms: number

territory

territory: number

title

title: string

unsubscribe

unsubscribe: number

visits

visits: number

weblead

weblead: string

Accessors

id

  • get id(): number

  • Returns number

Methods

getField

  • getField(field): Field

  • Returns NetSuite field metadata. Useful for doing things like disabling a field on the form programmatically.

    Parameters

    Returns Field

save

  • save(enableSourcing?, ignoreMandatoryFields?): number

  • Persists this record to the NS database

    Parameters

    • OptionalenableSourcing: boolean
    • OptionalignoreMandatoryFields: boolean

    Returns number

toJSON

  • toJSON(): any

  • Returns any

StaticrecordType

  • recordType(): Type

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

    Returns Type

Settings

Member Visibility

On This Page

Constructors
Properties
_idaccessroleaccountnumberaddressbookaltemailaltphoneautonamebalancebillpaybuyingreasonbuyingtimeframecategorycommentscompanynameconsoldaysoverduecontactrolescreditholdoverridecurrencycurrencyprecisioncustomformdatecreateddaysoverduedefaultValuesdefaultbankaccountdownloaddraccountemailemailtransactionsentityidentitystatusestimatedbudgetexternalidfaxfirstnamefxaccountglobalsubscriptionstatusgrouppricingimageisbudgetapprovedisinactiveispersonitempricingkeywordslanguagelastmodifieddatelastnamelastvisitleadsourcemiddlenamenegativenumberformatnsrecordnumberformatparentpartnerpartnersphoneprefccprocessorpricelevelprintoncheckasprinttransactionsreceivablesaccountreferrerresalenumbersalesgroupsalesreadinesssalesrepsalesteamsourcewebsitestagesubsidiarysyncpartnerteamssyncsalesteamstaxabletaxexempttaxfractionunittaxitemtaxroundingtermsterritorytitleunsubscribevisitsweblead
Accessors
Methods