incrementSeriesDocumentNumber
The incrementSeriesDocumentNumber
method increments the e-document number of a specific e-document series. It reserves and returns the next sequential number to be used for a new e-document.
Input Parameter
Use the following parameter to define for which series to increment the e-document number:
Parameter |
Type |
Description |
---|---|---|
seriesId |
String, Number |
Internal ID of the e-document series. |
Return Value
The method returns the next available e-document number in the selected series.
Property |
Type |
Description |
---|---|---|
success |
Boolean |
Indicates whether the number was incremented. |
message |
String |
Success or error message. |
documentNumber |
Number |
The incremented e-document number. |
Example
/**
* Increments the Document Number sequence from a given E-Document Series.
*
* @param {Object} context
* @returns {Object} result
*/
var incrementSeriesDocumentNumber = function (context) {
var ecsApi = loadEcsApi();
return ecsApi.incrementSeriesDocumentNumber(context, "");
};