Create a New Document Based on a Template documentgenerator.document.add

Scope: documentgenerator

Who can execute the method: user with permission to create documents

The method documentgenerator.document.add creates a new document based on a template.

Method Parameters

Required parameters are marked with *

Name `type`	Description
templateId* `integer`	Template identifier. You can obtain the template identifier after creating a template or by using the get template list method.
providerClassName `string`	Data provider class. Defaults to `Bitrix\DocumentGenerator\DataProvider\Rest`
value* `string`	External identifier of the object for which the document is being generated. The `value` format is defined by the integration. Use a consistent format within your application to search and filter documents. Recommended format: `<OBJECT_TYPE>_<ID>`, where: `<OBJECT_TYPE>` — string code of the object type in uppercase `<ID>` — numeric or string identifier of the object in the external system Examples of `value` for CRM objects: lead — `LEAD_123` contact — `CONTACT_45` company — `COMPANY_78` deal — `DEAL_901` estimate — `QUOTE_55` invoice — `INVOICE_12` Examples of `value` for other objects: order — `ORDER_1024` supply contract — `SUPPLY_CONTRACT_2026_015` record from external system — `ERP_DOC_A-7741`
values `object`	Field values of the document in the format `{"FieldCode":"Value"}`
stampsEnabled `integer`	Seal and signature mode: `1` — enable `0` — disable Defaults to the value from the template
fields `object`	Description of how to interpret and format values from `values` (detailed description). The key of the `fields` object must match the field code from the template. If you are only passing plain text, this parameter can be omitted. Example structure of `fields`: `{ "CurrentDate": { "TYPE": "DATE", "FORMAT": { "format": "d.m.Y" }, "TITLE": "Contract Date" } }`

Parameter fields

Name `type`	Description
TYPE `string`	Field type. Types for which formatting can be specified: `DATE` — date or date-time `NAME` — full name
FORMAT `object`	Formatting parameters for the field type. `FORMAT` is not fixed to one value; it should be chosen according to your template and output requirements. For `DATE`, the `format` value is specified in the format of document generator date modifiers. Example: `{"format":"d.m.Y"}` For `NAME`: `format` specifies the output template for name parts, e.g., `#NAME# #LAST_NAME#` `case` specifies the case User Documentation What are modifiers in document templates
PROVIDER `string`	Provider class
TITLE `string`	Field title

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"templateId":53,"value":"SUPPLY_CONTRACT_2026_015","values":{"DocumentNumber":"SC-2026-001","CurrentDate":"2026-03-18T00:00:00+02:00","ClientName":"Ltd. Daisy","ClientPhone":"+1 999 123-45-67","Total":"125000","Comment":"Payment within 5 business days after signing","UserName":"John Smith"},"fields":{"CurrentDate":{"TYPE":"DATE","FORMAT":{"format":"d.m.Y"},"TITLE":"Contract Date"}},"stampsEnabled":1}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.document.add

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"templateId":53,"value":"SUPPLY_CONTRACT_2026_015","values":{"DocumentNumber":"SC-2026-001","CurrentDate":"2026-03-18T00:00:00+02:00","ClientName":"Ltd. Daisy","ClientPhone":"+1 999 123-45-67","Total":"125000","Comment":"Payment within 5 business days after signing","UserName":"John Smith"},"fields":{"CurrentDate":{"TYPE":"DATE","FORMAT":{"format":"d.m.Y"},"TITLE":"Contract Date"}},"stampsEnabled":1,"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/documentgenerator.document.add

try
        {
            const response = await $b24.callMethod(
                'documentgenerator.document.add',
                {
                    templateId: 53,
                    value: 'SUPPLY_CONTRACT_2026_015',
                    values: {
                        DocumentNumber: 'SC-2026-001',
                        CurrentDate: '2026-03-18T00:00:00+02:00',
                        ClientName: 'Ltd. Daisy',
                        ClientPhone: '+1 999 123-45-67',
                        Total: '125000',
                        Comment: 'Payment within 5 business days after signing',
                        UserName: 'John Smith'
                    },
                    fields: {
                        CurrentDate: {
                            TYPE: 'DATE',
                            FORMAT: {
                                format: 'd.m.Y'
                            },
                            TITLE: 'Contract Date'
                        }
                    },
                    stampsEnabled: 1
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service->core->call(
                'documentgenerator.document.add',
                [
                    'templateId' => 53,
                    'value' => 'SUPPLY_CONTRACT_2026_015',
                    'values' => [
                        'DocumentNumber' => 'SC-2026-001',
                        'CurrentDate' => '2026-03-18T00:00:00+02:00',
                        'ClientName' => 'Ltd. Daisy',
                        'ClientPhone' => '+1 999 123-45-67',
                        'Total' => '125000',
                        'Comment' => 'Payment within 5 business days after signing',
                        'UserName' => 'John Smith',
                    ],
                    'fields' => [
                        'CurrentDate' => [
                            'TYPE' => 'DATE',
                            'FORMAT' => [
                                'format' => 'd.m.Y',
                            ],
                            'TITLE' => 'Contract Date',
                        ]
                    ],
                    'stampsEnabled' => 1,
                ]
            );
        
            $result = $response->getResponseData()->getResult();
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

BX24.callMethod(
            'documentgenerator.document.add',
            {
                templateId: 53,
                value: 'SUPPLY_CONTRACT_2026_015',
                values: {
                    DocumentNumber: 'SC-2026-001',
                    CurrentDate: '2026-03-18T00:00:00+02:00',
                    ClientName: 'Ltd. Daisy',
                    ClientPhone: '+1 999 123-45-67',
                    Total: '125000',
                    Comment: 'Payment within 5 business days after signing',
                    UserName: 'John Smith'
                },
                fields: {
                    CurrentDate: {
                        TYPE: 'DATE',
                        FORMAT: {
                            format: 'd.m.Y'
                        },
                        TITLE: 'Contract Date'
                    }
                },
                stampsEnabled: 1
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'documentgenerator.document.add',
            [
                'templateId' => 53,
                'value' => 'SUPPLY_CONTRACT_2026_015',
                'values' => [
                    'DocumentNumber' => 'SC-2026-001',
                    'CurrentDate' => '2026-03-18T00:00:00+02:00',
                    'ClientName' => 'Ltd. Daisy',
                    'ClientPhone' => '+1 999 123-45-67',
                    'Total' => '125000',
                    'Comment' => 'Payment within 5 business days after signing',
                    'UserName' => 'John Smith',
                ],
                'fields' => [
                    'CurrentDate' => [
                        'TYPE' => 'DATE',
                        'FORMAT' => [
                            'format' => 'd.m.Y',
                        ],
                        'TITLE' => 'Contract Date',
                    ]
                ],
                'stampsEnabled' => 1,
            ]
        );
        
        print_r($result);

Response Handling

HTTP status: 200

{
            "result": {
                "document": {
                    "downloadUrl": "/bitrix/services/main/ajax.php?action=documentgenerator.api.document.getfile&SITE_ID=s1&id=51&ts=1773844068",
                    "publicUrl": null,
                    "title": "SUPPLY_CONTRACT Template 1773843147554 SC-2026-001",
                    "number": "SC-2026-001",
                    "id": 51,
                    "createTime": "2026-03-18T17:27:48+02:00",
                    "createdBy": 503,
                    "updateTime": "2026-03-18T17:27:48+02:00",
                    "updatedBy": null,
                    "stampsEnabled": true,
                    "isTransformationError": false,
                    "value": "SUPPLY_CONTRACT_2026_015",
                    "values": {
                        "productsTableVariant": "",
                        "_creationMethod": "rest",
                        "stampsEnabled": true,
                        "DocumentNumber": "SC-2026-001",
                        "CurrentDate": "2026-03-18T00:00:00+02:00",
                        "ClientName": "Ltd. Daisy",
                        "ClientPhone": "+1 999 123-45-67",
                        "Total": "125000",
                        "Comment": "Payment within 5 business days after signing",
                        "UserName": "John Smith"
                    },
                    "templateId": "53",
                    "provider": "Bitrix\\DocumentGenerator\\DataProvider\\Rest",
                    "pullTag": "TRANSFORMDOCUMENT51",
                    "emailDiskFile": 5569,
                    "downloadUrlMachine": "https://**put_your_bitrix24_address**/rest/documentgenerator.api.document.getfile.json?auth=a0bfba690000071b00000844000001f7f0f1075f240da39bb5ea0e42c08c5fa182f3ed&token=documentgenerator%7CYWN0aW9uPWRvY3VtZW50Z2VuZXJhdG9yLmFwaS5kb2N1bWVudC5nZXRmaWxlJlNJVEVfSUQ9czEmaWQ9NTEmdHM9MTc3Mzg0NDA2OCZfPXZMVUFDSGMwQkY1QVpRbGQzTlNhV2ZIemNzMW5IZ1lM%7CImRvY3VtZW50Z2VuZXJhdG9yLmFwaS5kb2N1bWVudC5nZXRmaWxlfGRvY3VtZW50Z2VuZXJhdG9yfFlXTjBhVzl1UFdSdlkzVnRaVzUwWjJWdVpYSmhkRzl5TG1Gd2FTNWtiMk4xYldWdWRDNW5aWFJtYVd4bEpsTkpWRVZmU1VROWN6RW1hV1E5TlRFbWRITTlNVGMzTXpnME5EQTJPQ1pmUFhaTVZVRkRTR013UWtZMVFWcFJiR1F6VGxOaFYyWkllbU56TVc1SVoxbE18YTBiZmJhNjkwMDAwMDcxYjAwMDAwODQ0MDAwMDAxZjdmMGYxMDc1ZjI0MGRhMzliYjVlYTBlNDJjMDhjNWZhMTgyZjNlZCI%3D.6lsKyiThwQT0n4UyMQfXdyS%2BnBVTG08%2FpGguggYNGLE%3D"
                }
            },
            "time": {
                "start": 1773844068,
                "finish": 1773844068.572038,
                "duration": 0.572037935256958,
                "processing": 0,
                "date_start": "2026-03-18T17:27:48+02:00",
                "date_finish": "2026-03-18T17:27:48+02:00",
                "operating_reset_at": 1773844668,
                "operating": 0.9536302089691162
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response (detailed description)
time `time`	Information about the request execution time

Object result

Name `type`	Description
document `object`	Data of the created document (detailed description)

Object document

Name `type`	Description
id `integer`	Document identifier
title `string`	Document title
number `string`	Document number
templateId `integer`	Template identifier
provider `string`	Data provider class
value `string`	External identifier of the object
values `object`	Field values of the document (detailed description)
stampsEnabled `boolean`	Indicator of enabled seals and signatures
downloadUrl `string`	Link to download DOCX for the user
downloadUrlMachine `string`	Link to download DOCX for the application
publicUrl `string`	Public link to the document, if enabled
isTransformationError `boolean`	Indicator of document conversion error
pullTag `string`	Tag for subscribing to conversion status updates
emailDiskFile `integer`	File identifier on Drive for sending by e-mail
createTime `datetime`	Document creation time
updateTime `datetime`	Time of the last document update
createdBy `integer`	Identifier of the document author
updatedBy `integer`	Identifier of the user who updated the document

Object values

Name `type`	Description
_creationMethod `string`	Method of document creation
stampsEnabled `boolean`	Indicator of enabled seals and signatures
<field_code> `string`	Field value from the template by its code

File conversion to PDF is performed asynchronously. If the pdfUrl field is not filled immediately after creation, execute the documentgenerator.document.get method after 20-30 seconds.

Error Handling

HTTP status: 400, 403

{
            "error": "0",
            "error_description": "Cannot create document on deleted template"
        }

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

Status	Code	Description	Value
`400`	`100`	Bitrix\DocumentGenerator\Template constructor must be public	Required parameter `templateId` not provided
`400`	`0`	Empty required parameter "value"	Required parameter `value` not provided
`400`	`0`	Cannot create document on deleted template	Cannot create a document based on a deleted template
`400`	`0`	Template not found	No template exists with the specified `templateId`
`400`	`0`	Cannot create document	Failed to create document
`400`	`0`	You do not have permissions to view documents	Insufficient permissions to view documents
`400`	`0`	Maximum count of documents has been reached	Document limit reached on the plan
`403`	`DOCGEN_ACCESS_ERROR`	Access denied	Insufficient permissions to create document

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 allowed to be called 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 methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users
`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 option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Generating a document with complex tables

Modify an Existing Document

Create a New Document Based on a Template documentgenerator.document.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Object resultObject result

Object documentObject document

Object valuesObject values

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning