Numbering Rules: Overview of Methods

A numbering rule defines the number template and counter settings for CRM documents. For example, a numbering rule with the template INV-{NUMBER} assigns document numbers in the format INV-1, INV-2.

The numbering rule is a preliminary step: it is created once and linked to the document template via numeratorId. Multiple templates can use a single numbering rule, sharing one counter.

Quick navigation: all methods

User documentation: Create and configure auto numbering template in CRM

Getting StartedGetting Started

1. Create a numbering rule using the method crm.documentgenerator.numerator.add.
2. If you are using an already created numbering rule, retrieve the list of numbering rules and their identifiers using the method crm.documentgenerator.numerator.list.
3. If you know the id of the numbering rule and want to check its settings, use the method crm.documentgenerator.numerator.get.
4. Pass the numeratorId to the document template:
   • if creating a new template, use the method crm.documentgenerator.template.add.
   • if modifying an existing template, use the method crm.documentgenerator.template.update.
5. If you need to change the settings of the numbering rule, use the method crm.documentgenerator.numerator.update.
6. Delete an unnecessary numbering rule using the method crm.documentgenerator.numerator.delete.

Important ConsiderationsImportant Considerations

The methods crm.documentgenerator.numerator.update and crm.documentgenerator.numerator.delete only work with numbering rules created using the method crm.documentgenerator.numerator.add.

Relationship with Other ObjectsRelationship with Other Objects

Document Templates. The numbering rule is linked to the template via the numeratorId parameter in the methods crm.documentgenerator.template.add and crm.documentgenerator.template.update.

Documents. The document number is generated by the method crm.documentgenerator.document.add when creating a document from a template. If the numbering rule does not return the next number during generation, the method will return an error.

Overview of MethodsOverview of Methods

Scope: crm

Who can execute the method: a user with the "modify" permission for document generator templates

Method	Description
crm.documentgenerator.numerator.add	Adds a new numbering rule
crm.documentgenerator.numerator.update	Updates an existing numbering rule
crm.documentgenerator.numerator.get	Returns information about the numbering rule by identifier
crm.documentgenerator.numerator.list	Returns a list of numbering rules
crm.documentgenerator.numerator.delete	Deletes a numbering rule