Numbering Rules: Overview of Methods

Numbering rules define the format for document numbers:

• Number template, for example, DG-{NUMBER} or INV-{NUMBER}
• Parameters for generating the number in the placeholder {NUMBER}: starting value, step, and additional generator settings

Quick navigation: all methods

Getting StartedGetting Started

1. Retrieve the list of available numbering rules using the documentgenerator.numerator.list method.
2. If you need a custom numbering rule, create it using the documentgenerator.numerator.add method.
3. Get the settings of a numbering rule by its identifier using the documentgenerator.numerator.get method.
4. Pass the numbering rule identifier in the numeratorId field when creating a template or updating a template.
5. Modify the parameters of the custom numbering rule using the documentgenerator.numerator.update method.
6. Delete an unnecessary custom numbering rule using the documentgenerator.numerator.delete method.

Linking Numbering Rules with Other ObjectsLinking Numbering Rules with Other Objects

Document Templates. A numbering rule is linked to a template through the numeratorId field. To assign a numbering rule to a template, pass the numbering rule identifier to the documentgenerator.template.add or documentgenerator.template.update methods.

The numbering rule identifier can be obtained after creation or through the documentgenerator.numerator.list method.

Considerations When Modifying and Deleting a Numbering RuleConsiderations When Modifying and Deleting a Numbering Rule

The documentgenerator.numerator.update and documentgenerator.numerator.delete methods only work for numbering rules created via the documentgenerator.numerator.add method.

Overview of MethodsOverview of Methods

Scope: documentgenerator

Who can execute the methods: a user with permission to modify document generator templates

Method	Description
documentgenerator.numerator.add	Adds a numbering rule
documentgenerator.numerator.update	Modifies a numbering rule
documentgenerator.numerator.get	Retrieves a numbering rule by identifier
documentgenerator.numerator.list	Gets a list of numbering rules
documentgenerator.numerator.delete	Deletes a numbering rule