Invoice Group Record Actions
groupinvoices
|
Corresponding UI Button |
Group Invoices |
|
Action Description |
Groups invoices into groups based on the customer name and common criteria. The Invoice Groups feature must be enabled to use this action. For more information about the Invoice Groups feature, see Invoice Groups Overview. |
|
Returns |
{notifications:[], response:{}} |
|
Supported Script Types |
Client and server scripts For additional information, see SuiteScript 2.x Script Types. |
|
Governance |
None |
|
Since |
2020.2 |
The internal ID for this action is groupinvoices.
The Group Invoices action appears on the Invoice Groups Overview record type.
For help working with the invoice groups record in the UI, see Viewing the Invoice Group Record.
Supported Functions
The invoice group record is partially scriptable. It can be created, updated, deleted, and searched using SuiteScript. It cannot be copied or transformed.
Possible Error Messages
-
There are no invoices listed or some invoices are missing.
-
The invoice group does not exist.
-
The invoice group is partially or fully paid.
-
Some invoices in this group are partially or fully paid.
-
The user does not have permission or the invoice is restricted.
-
The number of invoices for this group is more than the maximum allowed.
Parameters
-
record id for invoice group
-
invoice list
Code Sample
require(['N/action'], function(actionMod) {
var result = actionMod.execute({id: 'groupinvoices', recordType: 'invoiceGroup', params: {recordId: 1, invoicelist:'3,4,9'}});
...
// Add additional code
removeinvoicesfromgroup
|
Corresponding UI Button |
Remove From Group |
|
Action Description |
Removes invoices from an invoice group. The Invoice Groups feature must be enabled to use this action. For more information about the Invoice Groups feature, see Invoice Groups Overview. |
|
Returns |
{notifications:[], response:{}} |
|
Supported Script Types |
Client and server scripts For additional information, see SuiteScript 2.x Script Types. |
|
Governance |
None |
|
Since |
2020.2 |
The internal ID for this action is removeinvoicesfromgroup.
The Remove From Group action appears on the Invoice Group record type.
For help working with the invoice groups record in the UI, see Viewing the Invoice Group Record.
Supported Functions
The invoice group record is partially scriptable. It can be created, updated, deleted, and searched using SuiteScript. It cannot be copied or transformed.
Possible Error Messages
-
There are no invoices listed or some invoices are missing.
-
The invoice group does not exist.
-
The invoice group is partially or fully paid.
-
Some invoices in this group are partially or fully paid.
-
The user does not have permission or the invoice is restricted.
Parameters
-
record id for invoice group
-
invoice list
Code Sample
require(['N/action'], function(actionMod) {
var result = actionMod.execute({id: 'removeinvoicesfromgroup', recordType: 'invoiceGroup', params: {recordId: 1, invoicelist:'3,4,9'}}); });
...
// Add additional code