NetSuite FastTrack Toolkit (NFT) - v8.0.0
    Preparing search index...

    Class SalesOrderBase

    NetSuite Sales Order Record

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _id allowemptycards althandlingcost altsalestotal altshippingcost authcode balance billaddresslist billingaddress billingschedule billisresidential canhavestackable ccapproved ccavsstreetmatch ccavszipmatch ccexpiredate cchold ccholdetails cciavsmatch ccname ccnumber ccprocessoraccount ccsecuritycode ccsecuritycodematch ccstreet cczipcode class consolidatebalance couponcode createddate createdfrom creditcard creditcardprocessor currency currencyname currencysymbol customercode customform debitcardissueno defaultValues? deferredrevenue deletionreason deletionreasonmemo department discountitem discountrate discounttotal draccount email enddate entity entitynexus entitytaxregnum estgrossprofit estgrossprofitpercent exchangerate excludecommission externalid fob fxaccount getauth giftcertapplied handlingcost handlingtax1rate handlingtaxcode ignoreavs ignorecsc inputpnrefnum intercostatus intercotransaction isbasecurrency isdefaultshippingrequest ismultishipto ispurchasecard isrecurringpayment istaxable item lastmodifieddate leadsource linkedtrackingnumbers location memo message messagesel muccpromocodeinstance nextbill nexus nsrecord onetime opportunity orderstatus otherrefnum overridehold overrideholdchecked overrideshippingcost partner paymenteventdate paymenteventholdreason paymenteventpurchasedatasent paymenteventresult paymenteventtype paymenteventupdatedby paymentmethod paypalauthid paypalprocess paypalstatus paypaltranid pnrefnum postingperiod promocode promocodepluginimpl recognizedrevenue recurannually recurmonthly recurquarterly recurweekly returntrackingnumbers revcommitstatus revenuestatus revreconrevcommitment saleseffectivedate salesgroup salesrep salesteam shipaddresslist shipcomplete shipdate shipisresidential shipmethod shipoverride shippingaddress shippingcost shippingcostoverridden shippingtax1rate shippingtaxcode softdescriptor source startdate status statusRef subsidiary subsidiarytaxregnum subtotal syncpartnerteams syncsalesteams taxdetailsoverride taxitem taxrate taxregoverride taxtotal terms threedstatuscode tobeemailed tobefaxed tobeprinted total totalcostestimate trandate tranid tranisvsoebundle unbilledorders validfrom vsoeautocalc

    Accessors

    id

    Methods

    findApplyLine getField save toJSON recordType

    Constructors

    • 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 SalesOrderBase

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

    • 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 SalesOrderBase

      // 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)

    • 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 SalesOrderBase

      // 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

    allowemptycards: boolean
    althandlingcost: number
    altsalestotal: number
    altshippingcost: number
    authcode: string
    balance: number
    billaddresslist: number
    billingaddress: AddressBase
    billingschedule: number
    billisresidential: string
    canhavestackable: boolean
    ccapproved: boolean
    ccavsstreetmatch: number
    ccavszipmatch: number
    ccexpiredate: string
    cchold: string
    ccholdetails: string
    cciavsmatch: number
    ccname: string
    ccnumber: string
    ccprocessoraccount: string
    ccsecuritycode: string
    ccsecuritycodematch: number
    ccstreet: string
    cczipcode: string
    class: number
    consolidatebalance: number
    couponcode: number
    createddate: Date
    createdfrom: number
    creditcard: number
    creditcardprocessor: number
    currency: number
    currencyname: string
    currencysymbol: string
    customercode: string
    customform: number
    debitcardissueno: string
    defaultValues?: object
    deferredrevenue: number
    deletionreason: number

    This field exists only if 'Use Deletion Reason' feature is enabled on the account

    deletionreasonmemo: string

    This field exists only if 'Use Deletion Reason' feature is enabled on the account

    department: number
    discountitem: number
    discountrate: number
    discounttotal: number
    draccount: number
    email: string
    enddate: null | Date
    entity: number
    entitynexus: number
    entitytaxregnum: number
    estgrossprofit: number
    estgrossprofitpercent: string
    exchangerate: number
    excludecommission: boolean
    externalid: string
    fob: string
    fxaccount: number
    getauth: boolean
    giftcertapplied: number
    handlingcost: number
    handlingtax1rate: string
    handlingtaxcode: number
    ignoreavs: boolean
    ignorecsc: boolean
    inputpnrefnum: string
    intercostatus: number
    intercotransaction: number
    isbasecurrency: boolean
    isdefaultshippingrequest: string
    ismultishipto: boolean
    ispurchasecard: string
    isrecurringpayment: boolean
    istaxable: boolean
    item: Sublist<ItemSublist>
    lastmodifieddate: Date
    leadsource: number
    linkedtrackingnumbers: string
    location: number
    memo: string
    message: string
    messagesel: number
    muccpromocodeinstance: string
    nextbill: null | Date
    nexus: number
    nsrecord: Record

    underlying netsuite record

    onetime: number
    opportunity: number
    orderstatus: string | number
    otherrefnum: string
    overridehold: boolean
    overrideholdchecked: boolean
    overrideshippingcost: number
    partner: number
    paymenteventdate: null | Date
    paymenteventholdreason: number
    paymenteventpurchasedatasent: string
    paymenteventresult: number
    paymenteventtype: string
    paymenteventupdatedby: string
    paymentmethod: number
    paypalauthid: string
    paypalprocess: boolean
    paypalstatus: string
    paypaltranid: string
    pnrefnum: string
    postingperiod: number
    promocode: number
    promocodepluginimpl: string
    recognizedrevenue: number
    recurannually: number
    recurmonthly: number
    recurquarterly: number
    recurweekly: number
    returntrackingnumbers: string
    revcommitstatus: string
    revenuestatus: string
    revreconrevcommitment: boolean
    saleseffectivedate: null | Date
    salesgroup: number
    salesrep: number
    salesteam: Sublist<SalesTeamSublist>
    shipaddresslist: number
    shipcomplete: boolean
    shipdate: null | Date
    shipisresidential: string
    shipmethod: number
    shipoverride: string
    shippingaddress: AddressBase
    shippingcost: number
    shippingcostoverridden: string
    shippingtax1rate: string
    shippingtaxcode: number
    softdescriptor: string
    source: string
    startdate: null | Date
    status: string

    Note unlike other identifiers in NetSuite, this one is a string (e.g. 'Partially Fulfilled')

    statusRef: string

    Note unlike other references in NetSuite, this one is a set of undocumented string keys (e.g. 'partiallyFulfilled') The possible statusref values differ for each transaction type

    subsidiary: number
    subsidiarytaxregnum: number
    subtotal: number
    syncpartnerteams: boolean
    syncsalesteams: boolean
    taxdetailsoverride: boolean
    taxitem: number
    taxrate: number
    taxregoverride: boolean
    taxtotal: number
    terms: number
    threedstatuscode: string
    tobeemailed: boolean
    tobefaxed: boolean
    tobeprinted: boolean
    total: number
    totalcostestimate: number
    trandate: Date
    tranid: string
    tranisvsoebundle: boolean
    unbilledorders: number
    validfrom: string
    vsoeautocalc: boolean

    Accessors

    Methods

    • locates line on the 'apply' sublist that corresponds to the passed related record internal id expose this method in derived classes that need dynamic access to the apply sublist returns undefined

      Parameters

      • docId: number

      Returns null | { amount: number; apply: boolean; line: number }

      • dynamic access to the apply sublist should generally work using normal collection oriented means

    • Persists this record to the NS database

      Parameters

      • OptionalenableSourcing: boolean
      • OptionalignoreMandatoryFields: boolean

      Returns number

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    _idallowemptycardsalthandlingcostaltsalestotalaltshippingcostauthcodebalancebilladdresslistbillingaddressbillingschedulebillisresidentialcanhavestackableccapprovedccavsstreetmatchccavszipmatchccexpiredateccholdccholdetailscciavsmatchccnameccnumberccprocessoraccountccsecuritycodeccsecuritycodematchccstreetcczipcodeclassconsolidatebalancecouponcodecreateddatecreatedfromcreditcardcreditcardprocessorcurrencycurrencynamecurrencysymbolcustomercodecustomformdebitcardissuenodefaultValuesdeferredrevenuedeletionreasondeletionreasonmemodepartmentdiscountitemdiscountratediscounttotaldraccountemailenddateentityentitynexusentitytaxregnumestgrossprofitestgrossprofitpercentexchangerateexcludecommissionexternalidfobfxaccountgetauthgiftcertappliedhandlingcosthandlingtax1ratehandlingtaxcodeignoreavsignorecscinputpnrefnumintercostatusintercotransactionisbasecurrencyisdefaultshippingrequestismultishiptoispurchasecardisrecurringpaymentistaxableitemlastmodifieddateleadsourcelinkedtrackingnumberslocationmemomessagemessageselmuccpromocodeinstancenextbillnexusnsrecordonetimeopportunityorderstatusotherrefnumoverrideholdoverrideholdcheckedoverrideshippingcostpartnerpaymenteventdatepaymenteventholdreasonpaymenteventpurchasedatasentpaymenteventresultpaymenteventtypepaymenteventupdatedbypaymentmethodpaypalauthidpaypalprocesspaypalstatuspaypaltranidpnrefnumpostingperiodpromocodepromocodepluginimplrecognizedrevenuerecurannuallyrecurmonthlyrecurquarterlyrecurweeklyreturntrackingnumbersrevcommitstatusrevenuestatusrevreconrevcommitmentsaleseffectivedatesalesgroupsalesrepsalesteamshipaddresslistshipcompleteshipdateshipisresidentialshipmethodshipoverrideshippingaddressshippingcostshippingcostoverriddenshippingtax1rateshippingtaxcodesoftdescriptorsourcestartdatestatusstatusRefsubsidiarysubsidiarytaxregnumsubtotalsyncpartnerteamssyncsalesteamstaxdetailsoverridetaxitemtaxratetaxregoverridetaxtotaltermsthreedstatuscodetobeemailedtobefaxedtobeprintedtotaltotalcostestimatetrandatetranidtranisvsoebundleunbilledordersvalidfromvsoeautocalc
    Accessors
    Methods