StandardLines

Type	Interface input object
Description	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. For more information, see Custom GL Lines Plug-in Process Flow.
Methods	getCount() getLine(index)
Child Object(s)	StandardLine

getCount()

Function Declaration	int getCount()
Type	Object method
Description	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() counts both visible and hidden lines on the GL Impact page. For an example of how to return only the number of visible lines, see Custom GL Lines Plug-in Guidelines and Best Practices.
Returns	int
Input Parameters	None.
Parent object	StandardLines

Example

             function customizeGlImpact(transactionRecord, standardLines, customLines, book)
   {
      ...
      for (var i = 0; i < standardLines.getCount(); i++) 
      {
         var currLine = standardLines.getLine(i);
         ...
      }
   } 

        

getLine(index)

Function Declaration	StandardLine getLine(int index)
Type	Object method
Description	Returns a StandardLine object that represents a standard line with GL impact. StandardLine objects are stored in the StandardLines object starting at index 0.
Returns	StandardLine
Input Parameters	index {int} — Integer value for the StandardLine object at the specified position in the StandardLines object.
Parent object	StandardLines

Example

             function customizeGlImpact(transactionRecord, standardLines, customLines, book)
   {
      ...
      for (var i = 0; i < standardLines.getCount(); i++) 
      {
         var currLine = standardLines.getLine(i);
         ...
      }
   } 

        

Related Topics

customizeGlImpact(transactionRecord, standardLines, customLines, book)

Record

CustomLines

AccountingBook

General Notices