transaction.void.promise(options)

Note:

The content in this help topic pertains to SuiteScript 2.0.

Method Description

Voids a transaction record object asynchronously and return an ID that indicates the type of void performed:

If a direct void is performed, this method returns the ID of the record that was voided.
If a void by reversing journal is performed, this method returns the ID of the newly created voiding journal.

The type of void performed depends on the targeted account’s preference settings.

Important:

After you void a transaction, you cannot make changes to the transaction that impact the general ledger.

Note:

The parameters and errors thrown for this method are the same as those for transaction.void(options). For more information about promises, see Promise Object.

Returns

Promise Object

Synchronous Version

transaction.void(options)

Supported Script Types

Client and server scripts

For more information, see SuiteScript 2.x Client Script Type.

Governance

10 units

Module

N/transaction Module

Since

2015.2

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete promise script example, see Promise Object.

          //Add additional code 
...
var voidSalesOrderId = transaction.void.promise({
          type: record.Type.SALES_ORDER,
          id: salesOrderId
          });
...
//Add additional code

Syntax

Related Topics