Create counter

Create a document counter used to assign document numbers.

Body Params
string
required
length between 1 and 100

Unique identifier. Must not be null. Must match with the regular expression '[a-zA-Z0-9_.-]{1,100}'. Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.-]{1,100}'.

int64
≥ 0
Defaults to 1

Minimal counter value, used for first document. And after reset, if configured. Must not be null. Must be greater than or equal to 0.

string | null

Counter mask, will be overlaid with current counter (mask=0000 + counter=12 => 0012). Size must be between 0 and 175.

string | null

Document number prefix pattern. In the pattern you can use special keywords wrapped with ## e.g. ##YEAR_SHORT##. Currently supported keywords are:

PatternExpands toExample for 2019-02-05
##YEAR##full year, four digits2019
##YEAR_SHORT##short year, last two digits19

Note: Yearly counter reset is controlled separately and independent of the patterns via the reset in the counter config. The length after expansion of the pre-/suffix can only be up to 20 characters.

string | null

If and when to reset the counter value. Must be one of:

NEW_YEAR
string | null

Document number suffix pattern. In the pattern you can use special keywords wrapped with ## e.g. ##YEAR_SHORT##. Currently supported keywords are:

PatternExpands toExample for 2019-02-05
##YEAR##full year, four digits2019
##YEAR_SHORT##short year, last two digits19

Note: Yearly counter reset is controlled separately and independent of the patterns via the reset in the counter config. The length after expansion of the pre-/suffix can only be up to 20 characters.

int64 | null

Maximal counter value or null. When a number is provided, it defines the highest permissible value and must be above the lowerLimit.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
Response
Choose an example:
application/json