Create a New Document crm.documentgenerator.document.add

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: crm

Who can execute the method: a user with "edit" access permission for document generator documents.

The method crm.documentgenerator.document.add creates a document based on a template for a CRM entity.

Method Parameters

Required parameters are marked with *

Name `type`	Description
templateId^* `integer`	Identifier of the document template
entityTypeId^* `integer`	Identifier of the CRM entity type for which the document is created. Typical values: `1` — lead `2` — deal `3` — contact `4` — company `5` — invoice (old version) `7` — estimate `31` — invoice For Smart Processes, their `entityTypeId` is passed, for example, `177`
entityId^* `integer`	Identifier of the CRM entity based on which the document is created
values `object`	Object with the values of the document fields. Format: `{ "field_1": "value_1", "field_2": "value_2" }` where: `field_n` — field code of the document `value_n` — field value The set of keys depends on the specific template and data provider. Available fields can be viewed using the method crm.documentgenerator.document.getfields
stampsEnabled `integer`	Include stamp and signature: `1` — include `0` — do not include Default is `0`
fields `object`	Additional descriptions of document fields for generation. The `fields` parameter is used for more precise field configuration. In most scenarios, the `values` parameter is sufficient. In `fields`, a field descriptor object is passed. Example: `{ "DocumentTitle": { "title": "Document Title", "value": "Demo Implementation of Product 1", "required": "Y", "default": "Demo Implementation of Product 1", "chain": [ {}, "getTitle" ], "VALUE": "Test via fields" } }` The list of `fields` keys is not fixed and depends on the template. How to access available parameters: before creating the document — crm.documentgenerator.template.getfields, field `templateFields` for the created document — crm.documentgenerator.document.getfields, field `documentFields` Service fields `SOURCE` and `DOCUMENT` are ignored. Some computed fields may not be overridden via `fields`

Method Feature

pdfUrl and imageUrl may be absent immediately after creation, as conversion is performed asynchronously. To check the result, use crm.documentgenerator.document.get

Code Examples

How to Use Examples in Documentation

Example of creating a document where:

templateId — 39
entityTypeId — 2 (deal)
entityId — 101
document number is passed via values.DocumentNumber
for fields.DocumentTitle, a descriptor object is passed

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"templateId":39,"entityTypeId":2,"entityId":101,"values":{"DocumentNumber":"2026-001"},"fields":{"DocumentTitle":{"title":"Document Title","value":"Demo Implementation of Product 1","required":"Y","default":"Demo Implementation of Product 1","chain":[{},"getTitle"],"VALUE":"Test via fields"}},"stampsEnabled":1}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.documentgenerator.document.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"templateId":39,"entityTypeId":2,"entityId":101,"values":{"DocumentNumber":"2026-001"},"fields":{"DocumentTitle":{"title":"Document Title","value":"Demo Implementation of Product 1","required":"Y","default":"Demo Implementation of Product 1","chain":[{},"getTitle"],"VALUE":"Test via fields"}},"stampsEnabled":1,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.documentgenerator.document.add

try
        {
            const response = await $b24.callMethod(
                'crm.documentgenerator.document.add',
                {
                    templateId: 39,
                    entityTypeId: 2,
                    entityId: 101,
                    values: {
                        DocumentNumber: '2026-001',
                    },
                    fields: {
                        DocumentTitle: {
                            title: 'Document Title',
                            value: 'Demo Implementation of Product 1',
                            required: 'Y',
                            default: 'Demo Implementation of Product 1',
                            chain: [{}, 'getTitle'],
                            VALUE: 'Test via fields',
                        },
                    },
                    stampsEnabled: 1,
                }
            );
        
            const result = response.getData().result;
            console.info(result);
        }
        catch (error)
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.documentgenerator.document.add',
                    [
                        'templateId' => 39,
                        'entityTypeId' => 2,
                        'entityId' => 101,
                        'values' => [
                            'DocumentNumber' => '2026-001',
                        ],
                        'fields' => [
                            'DocumentTitle' => [
                                'title' => 'Document Title',
                                'value' => 'Demo Implementation of Product 1',
                                'required' => 'Y',
                                'default' => 'Demo Implementation of Product 1',
                                'chain' => [
                                    [],
                                    'getTitle',
                                ],
                                'VALUE' => 'Test via fields',
                            ],
                        ],
                        'stampsEnabled' => 1,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding document: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.documentgenerator.document.add',
            {
                templateId: 39,
                entityTypeId: 2,
                entityId: 101,
                values: {
                    DocumentNumber: '2026-001',
                },
                fields: {
                    DocumentTitle: {
                        title: 'Document Title',
                        value: 'Demo Implementation of Product 1',
                        required: 'Y',
                        default: 'Demo Implementation of Product 1',
                        chain: [{}, 'getTitle'],
                        VALUE: 'Test via fields',
                    }
                },
                stampsEnabled: 1,
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.documentgenerator.document.add',
            [
                'templateId' => 39,
                'entityTypeId' => 2,
                'entityId' => 101,
                'values' => [
                    'DocumentNumber' => '2026-001',
                ],
                'fields' => [
                    'DocumentTitle' => [
                        'title' => 'Document Title',
                        'value' => 'Demo Implementation of Product 1',
                        'required' => 'Y',
                        'default' => 'Demo Implementation of Product 1',
                        'chain' => [
                            [],
                            'getTitle',
                        ],
                        'VALUE' => 'Test via fields',
                    ],
                ],
                'stampsEnabled' => 1,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": {
                "document": {
                    "changeStampsEnabled": false,
                    "changeStampsDisabledReason": "No stamps and signatures in the template",
                    "changeQrCodeEnabled": false,
                    "qrCodeEnabled": false,
                    "changeQrCodeDisabledReason": "No QR code in the template",
                    "products": {
                        "currencyId": "EUR",
                        "totalSum": "0.00",
                        "totalRows": 0
                    },
                    "downloadUrl": "https://bitrix.bitrix24.com/bitrix/services/main/ajax.php?action=crm.documentgenerator.document.download&SITE_ID=s1&id=61",
                    "downloadUrlMachine": "https://bitrix.bitrix24.com/rest/crm.documentgenerator.document.download.json?...",
                    "publicUrl": null,
                    "id": 61,
                    "title": "Demo Implementation of Product 2026-001",
                    "number": "2026-001",
                    "createTime": "2026-03-20T13:51:45+01:00",
                    "createdBy": 577,
                    "updateTime": "2026-03-20T13:51:45+01:00",
                    "updatedBy": null,
                    "stampsEnabled": true,
                    "isTransformationError": false,
                    "values": {
                        "productsTableVariant": "",
                        "_creationMethod": "rest",
                        "stampsEnabled": true,
                        "DocumentNumber": "2026-001"
                    },
                    "templateId": "39",
                    "pullTag": "TRANSFORMDOCUMENT61",
                    "imageUrl": "https://bitrix.bitrix24.com/bitrix/services/main/ajax.php?action=crm.documentgenerator.document.getImage&SITE_ID=s1&id=61",
                    "pdfUrl": "https://bitrix.bitrix24.com/bitrix/services/main/ajax.php?action=crm.documentgenerator.document.getPdf&SITE_ID=s1&id=61",
                    "emailDiskFile": 5605,
                    "entityId": "101",
                    "entityTypeId": "2"
                }
            },
            "time": {
                "start": 1774003904,
                "finish": 1774003905.448804,
                "duration": 1.4488039016723633,
                "processing": 1,
                "date_start": "2026-03-20T13:51:44+01:00",
                "date_finish": "2026-03-20T13:51:45+01:00",
                "operating_reset_at": 1774004504,
                "operating": 0.9240179061889648
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response. Returns the `result` object
time `time`	Information about the request execution time

Type result

Name `type`	Description
document `object`	Data of the created document. The structure is described in the `document` type

Type document

Name `type`	Description
id `integer`	Identifier of the document
title `string`	Title of the document
number `string`	Document number
createTime `datetime`	Creation date
updateTime `datetime`	Update date
createdBy `integer`	Identifier of the user who created the document
updatedBy `integer` \| `null`	Identifier of the user who updated the document
changeStampsEnabled `boolean`	Can the stamp and signature inclusion be changed
changeStampsDisabledReason `string`	Reason why the stamp and signature inclusion cannot be changed
changeQrCodeEnabled `boolean`	Can the QR code be enabled or disabled
qrCodeEnabled `boolean`	Current state of the QR code
changeQrCodeDisabledReason `string`	Reason why the QR code cannot be changed
products `object`	Summary information about the document's products (`currencyId`, `totalSum`, `totalRows`)
stampsEnabled `boolean`	Stamp and signature inclusion flag
downloadUrl `string`	Link to download the document
downloadUrlMachine `string`	Link to download the document for machine access
publicUrl `string` \| `null`	Public link to the document
isTransformationError `boolean`	Flag indicating a document conversion error
transformationErrorMessage `string`	Text of the conversion error if `isTransformationError = true`
transformationErrorCode `string`	Code of the conversion error if `isTransformationError = true`
templateId `integer`	Identifier of the template
pullTag `string`	Event tag for document transformation
emailDiskFile `integer`	Identifier of the file in Drive for sending via email
entityTypeId `integer`	Identifier of the CRM entity type
entityId `integer`	Identifier of the CRM entity
values `object`	Values of the document fields passed during creation
imageUrl `string`	Link to the document image, if already created
pdfUrl `string`	Link to the PDF file of the document, if already created

Error Handling

HTTP Status: 400

{
            "error": "0",
            "error_description": "No provider for entityTypeId"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description	Value
`0`	No provider for entityTypeId	No data provider found for the provided `entityTypeId`
`0`	Empty required parameter "value"	`entityId` not provided or is empty
`0`	Cannot create document on deleted template	Cannot create a document based on a deleted template
`0`	Cannot create document	Error creating document based on the template
`DOCGEN_ACCESS_ERROR`	Access denied	No access to create the document
`DOCGEN_LIMIT_ERROR`	Maximum count of documents has been reached	Exceeded the limit of documents in the plan
`0`	Error getting next number	Failed to get the next document number from the number generator
`100`	Bitrix\DocumentGenerator\Template constructor must be public	Low-level error when calling without a valid `templateId`
`0`	Module documentgenerator is not installed	The `documentgenerator` module is not available
`0`	Template not found	Template with the specified `templateId` not found or unavailable

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not permitted for calls using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Overview of Methods

Modify Document

Create a New Document crm.documentgenerator.document.add

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Type resultType result

Type documentType document

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning