incrementEDocumentBulkNumber
The incrementEDocumentBulkNumber method increments the bulk e-document number stored in the Certification E-Document Settings record for a specific subsidiary and e-document category. This number serves as a shared reference for a group of e-documents processed together in bulk certification operations.
Input Parameters
Use these parameters to define the certification settings where the bulk number will be incremented.
|
Parameter |
Type |
Description |
|---|---|---|
|
apiContext |
Object |
Contains the required context for the request. |
apiContext:
|
Field |
Type |
Description |
|---|---|---|
|
subsidiaryId |
String, Number |
Subsidiary internal ID. |
|
category |
String |
External ID of the e-document category. Accepted values:
|
Return Value
The method returns the next available bulk number in the configuration.
|
Property |
Type |
Description |
|---|---|---|
|
success |
Boolean |
Indicates whether the request succeeded. |
|
message |
String |
Success or error message. |
|
documentNumber |
Number |
The new incremented bulk number. |
Example
/**
* Increments the Current E-Document Bulk Number sequence.
*
* @param {Object} context
* @returns {Object} result
*/
var incrementEDocumentBulkNumber = function (context) {
var ecsApi = loadEcsApi();
return ecsApi.incrementEDocumentBulkNumber(context, "");
};