@hitc/netsuite-types 2026.1.7 → 2026.1.8

package/ElectronicBankPaymentsPlugin.d.ts

@@ -0,0 +1,124 @@
+import type {EntryPoints} from './N/types'
+import type {Form} from './N/ui/serverWidget'
+
+/** Taken from https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_0724075122.html */
+interface EPForm {
+	/** Adds a column on the sublist of the Invoice Payment Processing page to display field values from the records searched */
+	AddColumn(
+		/**
+		 * The field type of the column
+		 */
+		type: ColumnType,
+		/**
+		 * The name of the column displayed on the sublist of the Invoice Payment Processing page.
+		 */
+		name: string,
+		/**
+		 * The internal ID name of the column you want to add on the sublist.
+		 * The reference argument can be a standard or custom entity field.
+		 * The reference argument can also be a standard or custom transaction field.
+		 */
+		reference: string,
+		/**
+		 * If value is true, the column displays the text or readable value of the field.
+		 * If the value is false, the column displays the id of the field value.
+		 */
+		isText?: boolean,
+		/**
+		 * The display type of the column added to the sublist on the Invoice Payment Processing page.
+		 */
+		displayType?: ColumnDisplayType,
+		/**
+		 * The default value of the column that is displayed on the sublist automatically when the Invoice Payment Processing page loads.
+		 */
+		defaultValue?: string,
+		/**
+		 * The join id for the search return column.
+		 */
+		join?: string
+	): void;
+	/** Adds a filter on the Bill Payment Processing page. The filter refines the search of bills to be processed */
+	AddFilter(
+		/**
+		 * If value is true, the filter is added to the existing Search Filters group on the Bill Payment Processing page.
+		 * If value is false, a new group of filters, named Custom Transaction Filters, is added to the Bill Payment Processing page.
+		 */
+		isDefaultFilter: boolean,
+		/**
+		 * The internal ID name of the field you want to add as a filter.
+		 * Note that you can only add fields from the transaction record.
+		 * If you want to source a newly created transaction body field or transaction column field, the reference argument must be the id of the newly created field.
+		 */
+		reference: string,
+		/**
+		 * The field type of the filter
+		 */
+		type: FilterType,
+		/**
+		 * The label of the filter displayed on the Bill Payment Processing page.
+		 */
+		label: string,
+		/**
+		 * The display type of the filter on the Bill Payment Processing page.
+		 */
+		displayType?: FilterDisplayType,
+		/**
+		 * The default value of the filter that is displayed automatically when the Bill Payment Processing page loads
+		 */
+		defaultValue?: string,
+		/**
+		 * The text displayed when the filter label is clicked.
+		 * The helpText value describes the data searched for when the filter is used
+		 */
+		helpText?: string,
+		/**
+		 * Specifies the source where the filter gets its autopopulated values.
+		 * An example value is the internal id of a list or record.
+		 * Note that source must have a value if the type argument is select or multiselect, for the values of the filter to be displayed.
+		 */
+		source?: string,
+		/**
+		 * A whole number that defines the allowed length of the value entered on the filter.
+		 */
+		maxLength?: number
+	): void;
+	/** Builds the customized Invoice Payment Processing page. This method must be called after all changes are made. */
+	BuildUI(context: EntryPoints.Suitelet.onRequestContext): void;
+	/** Get the form and generate it. */
+	GetForm(): Form;
+	/**
+	 * Removes an existing (default) field from the Payment Information group of the Invoice Payment Processing page.
+	 * Some fields cannot be removed, see https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_4024135775.html for details.
+	 */
+	RemoveField(
+		/** The field ID of the existing field that you want to remove */
+		fieldId: string
+	): void;
+	/**
+	 * Removes an existing (default) filter from the “Search Filter” group of the Invoice Payment Processing page.
+	 * Some filters cannot be removed, see https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_0724030613.html for details.
+	 */
+	RemoveFilter(
+		/** The field ID from the “Search Filter” group of the Invoice Payment Processing page that you want to remove */
+		fieldId: string
+	): void;
+	/** Use the setPaymentType method to setup the payment type */
+	setPaymentType(type: PaymentType): void;
+	/** Use setGlobalPayment to setup the global payments Suitelet */
+	setGlobalPayment(isGlobal: boolean): void;
+}
+
+type ColumnType = 'text' | 'integer' | 'date' | 'currency';
+
+type ColumnDisplayType = 'normal' | 'hidden';
+
+type FilterType = 'text' | 'date' | 'checkbox' | 'select' | 'multiselect' | 'integer' | 'currency' | 'longtext';
+
+type FilterDisplayType = 'inline' | 'normal' | 'hidden' | 'disabled';
+
+type PaymentType = 'DD' | 'EFT' | 'CR' | 'PP';
+
+export interface EPPlugin extends Record<string, (...s: unknown[]) => unknown> {
+	/** Returns an epForm object to customize the Invoice Payment Processing page */
+	getEPForm: () => EPForm;
+}

package/EmailCapturePlugin.d.ts

@@ -0,0 +1,32 @@
+interface IAddress {
+  getEmail(): string;
+  getName():  string;
+}
+
+interface IAttachment {
+  /**
+   * Object that represents an attachment in an email message sent to an Email Capture plug-in implementation.
+   * Each Attachment object contains properties for the attachment file name, attachment type, and the value of the attachment file.
+   */
+  getName(): string;
+  /** Returns the file type of an attachment in an email message as a string. For example, this method returns PLAINTEXT, PDF, and MISCBINARY for text, PDF, and Microsoft Word files, respectively. */
+  getType(): string;
+  /**
+   * Returns a text string for a text file attachment or base-64 encoded string for binary attachment types of an email message.
+   * You can use getType() to define the behavior of the plug-in implementation depending on the file type of the attachment.
+   */
+  getValue(): string;
+}
+
+/** Object that represents an email message sent to the Email Capture plug-in implementation. */
+interface IEmail {
+  getAttachments(): IAttachment[];
+  getCc():          IAddress[];
+  getFrom():        IAddress; // Documentation incorrectly shows this as an array, but an email only comes from one address.
+  getHtmlBody():    string;
+  getReplyTo():     IAddress;
+  getSentDate():    Date;
+  getSubject():     string;
+  getTextBody():    string;
+  getTo():          IAddress[]; // Documentation incorrectly shows this as a single address, but testing confirms that it's an array.
+}

package/N/record.d.ts

@@ -478,7 +478,7 @@ export type FieldValue = Date | number | number[] | string | string[] | boolean
 export interface ClientCurrentRecord {
     /** Cancels the currently selected line on a sublist. */
     cancelLine(options: CancelCommitLineOptions): Record;
-    cancelLine(sublistId: string): Record;
+    // cancelLine(sublistId: string): Record; // Deprecated in 2026.1.8
     /** Commits the currently selected line on a sublist. */
     commitLine(options: CommitLineOptions): Record;
     copy: RecordCopyFunction;
@@ -490,14 +490,13 @@ export interface ClientCurrentRecord {
     findSublistLineWithValue(options: FindSublistLineWithValueOptions): number;
     /** Gets the value for the currently selected line in the matrix. */
     getCurrentMatrixSublistValue(options: GetCurrentMatrixSublistValueOptions): number | Date | string | string[] | boolean;
-    /** Returns the line number of the currently selected line. */  
-    
     /**
      * return field object from record's sublist current line. Only available in dynamic record
      * @throws {SuiteScriptError} SSS_MISSING_REQD_ARGUMENT if sublistId or fieldId is missing
      * @restriction only available in dynamic record
      */
     getCurrentSublistField(options: GetCurrentSublistFieldOptions): Field;
+    /** Returns the line number of the currently selected line. */
     getCurrentSublistIndex(options: RecordGetLineCountOptions): number;
     /** Gets the subrecord for the associated sublist field on the current line. */
     getCurrentSublistSubrecord(options: GetCurrentSublistValueOptions): Record;
@@ -505,9 +504,7 @@ export interface ClientCurrentRecord {
     getCurrentSublistText(options: GetCurrentSublistValueOptions): string;
     /** Returns the value of a sublist field on the currently selected sublist line. */
     getCurrentSublistValue(options: GetCurrentSublistValueOptions): FieldValue;
-    getCurrentSublistValue(sublistId: string, fieldId: string): FieldValue;
-
-    
+    // getCurrentSublistValue(sublistId: string, fieldId: string): FieldValue; // Deprecated in 2026.1.8
     /** 
      * Returns a field object from a record. 
      * 
@@ -516,7 +513,7 @@ export interface ClientCurrentRecord {
     getField(options: GetFieldOptions): Field | null;
     /** Returns the number of lines in a sublist. */
     getLineCount(options: RecordGetLineCountOptions): number;
-    getLineCount(sublistId: string): number;
+    // getLineCount(sublistId: string): number; // Deprecated in 2026.1.8
     /** Provides a macro to be executed. */
     getMacro(options: { id: string }): Function; // TODO: Test this!
     /** Provides a plain JavaScript object of available macro objects defined for a record type, indexed by the Macro ID. */
@@ -545,7 +542,7 @@ export interface ClientCurrentRecord {
     getSublistText(options: GetSublistValueOptions): string;
     /** Returns the value of a sublist field. */
     getSublistValue(options: GetSublistValueOptions): FieldValue;
-    getSublistValue(sublistId: string, fieldId: string, line: number): FieldValue;
+    // getSublistValue(sublistId: string, fieldId: string, line: number): FieldValue; // Deprecated in 2026.1.8
     /** Gets the subrecord for the associated field. */
     getSubrecord(options: GetFieldOptions): Omit<Record, "save">;
     /** Returns the text representation of a field value. */
@@ -607,7 +604,7 @@ export interface ClientCurrentRecord {
     removeSubrecord(options: GetFieldOptions): this;
     /** Selects an existing line in a sublist. */
     selectLine(options: SelectLineOptions): this;
-    selectLine(sublistId: string, line: number): this;
+    // selectLine(sublistId: string, line: number): this; // Deprecated in 2026.1.8
     /** Selects a new line at the end of a sublist. */
     selectNewLine(options: RecordGetLineCountOptions): this;
     /** Sets the value for the line currently selected in the matrix. */
@@ -616,7 +613,7 @@ export interface ClientCurrentRecord {
     setCurrentSublistText(options: SetCurrentSublistTextOptions): this;
     /** Sets the value for the field in the currently selected line. */
     setCurrentSublistValue(options: SetCurrentSublistValueOptions): this;
-    setCurrentSublistValue(sublistId: string, fieldId: string, value: FieldValue): this;
+    // setCurrentSublistValue(sublistId: string, fieldId: string, value: FieldValue): this;  // Deprecated in 2026.1.8
     /** Sets the value for the associated header in the matrix. */
     setMatrixHeaderValue(options: SetCurrentMatrixSublistValueOptions): Record;
     /** Sets the value for the associated field in the matrix. */

package/SuiteGL.d.ts

@@ -0,0 +1,190 @@
+/** 
+ * NOTE: This file is for SSV1 as of Sept 2024 SSV2 is now supported and has been added to the SSV2. To use
+ * the SSV2 version (recommended) the types can be found in EntryPoints namespace in N/types
+ * 
+ * EntryPoints.Plugins.GlPlugin.customizeGlImpact
+ * 
+ * 
+ */
+
+/**
+ * Represents the accounting book passed to a Custom GL Lines plug-in implementation when you save a transaction.
+ * Use the methods available to the book object to determine if the book is a primary or secondary book or get
+ * the internal NetSuite ID of the accounting book.  If you use the Multi-Book Accounting feature, the
+ * AccountingBook object represents a different accounting book each time the plug-in implementation executes.
+ */
+interface AccountingBook {
+  /** Returns the internal NetSuite ID for the accounting book to be passed to a Custom GL Lines plug-in implementation. */
+  getId(): number;
+  /** Returns true if the book object is the primary accounting book for the NetSuite account or returns false if the accounting book is a secondary accounting book. */
+  isPrimary(): boolean;
+}
+
+/** These methods exist for both Custom lines and Standard lines. */
+interface GLLine {
+  /** Get Account ID for a line. */
+  getAccountId(): number;
+  /** Returns the internal NetSuite ID for the class on a StandardLine or CustomLine object. */
+  getClassId(): number;
+  /** Returns the credit amount for a StandardLine or CustomLine object. */
+  getCreditAmount(): string;
+  /** Returns the debit amount for a StandardLine or CustomLine object. */
+  getDebitAmount(): string;
+  /** Returns the internal NetSuite ID for the department on a StandardLine or CustomLine object. */
+  getDepartmentId(): number;
+  /** Returns the internal NetSuite ID of the entity for a standard line. */
+  getEntityId(): number;
+  /** Returns the internal NetSuite ID for the location on a StandardLine or CustomLine object. */
+  getLocationId(): number;
+  /** Returns the Memo field on a StandardLine or CustomLine object. */
+  getMemo(): string;
+  /**
+   * Returns the internal NetSuite ID for the custom segment value set on the line on a StandardLine or CustomLine object.
+   * @param {string} segmentId
+   */
+  getSegmentValueId(segmentId: string): number;
+}
+
+/** 
+ * Contains all properties for a single custom line for the GL impact on a transaction.
+ * Use the methods available to the CustomLine object to set the values for the custom
+ * line and define plug-in implementation functionality based on the values. The CustomLines
+ * object contains a reference to each custom GL impact line.
+ */
+interface CustomLine extends GLLine {
+  /**
+   * Sets the account ID property for a CustomLine object in a primary or secondary book.
+   * @param {number} accountId Internal NetSuite ID for an account.
+   */
+  setAccountId (accountId: number): void; 
+  /**
+   * Sets the class ID property for a CustomLine object in a primary or secondary book.
+   * @param {number} classId Internal NetSuite ID for a class
+   */
+  setClassId (classId: number): void;
+  /**
+   * Sets the credit amount of a CustomLine object in a primary or secondary book.
+   * @param {string|number} credit String value of a credit on a general ledger account. Requires a positive value.
+   */
+  setCreditAmount (credit: string|number): void;
+  /**
+   * Sets the credit amount of a CustomLine object in a primary or secondary book.
+   * @param {string|number} debit String value of a debit on a general ledger account. Requires a positive value.
+   */
+  setDebitAmount (debit: string|number): void;
+  /**
+   * Sets the department ID of a CustomLine object in a primary or secondary book.
+   * @param {number} departmentId
+   */
+  setDepartmentId (departmentId: number): void;
+  /**
+   * Sets the entity ID property for a CustomLine object in a primary or secondary book to the internal NetSuite ID.
+   * @param {number} entityId
+   */
+  setEntityId (entityId: number): void;
+  /**
+   * Sets the Location ID of a CustomLine object in a primary or secondary book.
+   * @param {number} locationId
+   */
+  setLocationId (locationId: number): void;
+  /**
+   * Sets the Memo field on a CustomLine object. See also getMemo().
+   * @param {string} memo
+   */
+  setMemo (memo: string): void;
+  /**
+   * Sets custom segment values on a CustomLine object. See also getSegmentValueId().
+   * @param {string} segmentId
+   * @param {string} segmentValueId
+   */
+  setSegmentValueId (segmentId: string, segmentValueId: number): void;
+   /**
+   * Sets a custom GL impact line to affect only the primary book in a Custom GL plug-in implementation.
+   * If you use this method and set the value to false,
+   * the plug-in implementation copies the custom line to secondary books and the custom line is also subject to the any mapping set up for the Multi-Book Accounting feature.
+   *
+   * If you do not use this method or set the value to true, the custom GL impact line only applies to the primary accounting book and is not copied to secondary accounting books.
+   * @param {boolean} bookSpecific
+   */
+  setBookSpecific(bookSpecific: boolean): void;
+  /**
+   * Returns true if the custom line is specific to the primary book and should not be copied to the secondary accounting books.
+   * Returns false if the custom line is not specific to the primary accounting book.
+   */
+  isBookSpecific(): boolean;
+}
+
+/** 
+ * Contains an array of all custom lines with GL impact in a transaction as CustomLine objects.
+ * Use this object to add and modify custom lines with GL impact on a transaction.
+ * Create a new CustomLine object with addNewLine().
+ */
+interface CustomLines {
+  /**
+   * Adds a CustomLine object to the parent CustomLines object in a Custom GL Lines plug-in
+   * implementation and returns the new object. Use this method to add a custom line with
+   * GL impact to a transaction. After you create the custom line, use the methods available
+   * to the CustomLine object to set the properties of the custom line, including the general
+   * ledger account ID and the amount of the custom line.
+   */
+  addNewLine(): CustomLine;
+    /**
+   * Returns the number of custom lines with GL impact for a specific accounting book in a transaction.
+   * Use this method in conjunction with getLine(index) to read individual custom lines.
+   */
+  getCount(): number;
+  /**
+   * Returns a CustomLine object that represents a custom line with GL impact.
+   * CustomLine objects are stored in the CustomLines object starting at index 0.
+   * @param {number} index
+   */
+  getLine (index: number): CustomLine;
+}
+
+/** 
+ * Contains all properties for a single standard line on the GL impact on a transaction.
+ * Use the methods available to the StandardLine object to get the values for the standard
+ * line and define plug-in implementation functionality based on the values. The
+ * StandardLines object has a StandardLine object for each standard GL impact line.
+ */
+interface StandardLine extends GLLine {
+  /**
+   * Returns the internal NetSuite database ID for a standard GL impact line.
+   * The summary line for the GL impact on a transaction occurs for most transaction types at ID of 0.
+   * Some transactions, like journals, do not have a summary line.
+   */
+  getId(): number;
+  /** Returns the internal NetSuite ID of the subsidiary for the entity associated with a standard GL impact line. */
+  getSubsidiaryId(): number;
+  /** Returns a string that represents the amount of a standard GL line that was subject to tax. */
+  getTaxableAmount(): string;
+  /** Returns a string that represents the amount of tax charged on a standard GL line. */
+  getTaxAmount(): string;
+  /** Returns the internal NetSuite ID of the tax code for a standard GL line. */
+  getTaxItemId(): number;
+  /** Returns the tax type for a standard GL line that was subject to tax. */
+  getTaxType(): string;
+  /** Returns true if the transaction is a posting transaction and the associated standard GL impact line posts to the general ledger. */
+  isPosting(): boolean;
+  /** Returns true if a standard GL impact line is a credit to a tax account. */
+  isTaxable(): boolean;
+}
+
+/** 
+ * Contains an array of all standard lines with GL impact in a transaction as StandardLine objects.
+ * Standard lines are the general ledger impacts that appear on the GL Impact report for a transaction.
+ * Use this object to access individual standard lines for an accounting book in a transaction.
+ */
+interface StandardLines {
+  /**
+   * Returns the number of standard lines with GL impact for a specific accounting book in a transaction.
+   * Use this method in conjunction with getLine(index) to read individual standard lines.
+   */
+  getCount(): number;
+  /**
+   * Returns a StandardLine object that represents a standard line with GL impact.
+   * StandardLine objects are stored in the StandardLines object starting at index 0.
+   * @param {number} index
+   */
+  getLine (index: number): StandardLine;
+}