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:
crmWho 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 object.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
templateId* |
Identifier of the document template |
|
entityTypeId* |
Identifier of the CRM object type for which the document is created. Typical values:
For Smart Processes, their |
|
entityId* |
Identifier of the CRM object based on which the document is created |
|
values |
Object with the values of the document fields. Format:
where:
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 |
Include stamp and signature:
Default is |
|
fields |
Additional descriptions of document fields for generation. The In
The list of How to access available parameters:
Service fields Some computed fields may not be overridden via |
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—39entityTypeId—2(deal)entityId—101- document number is passed via
values.DocumentNumber - for
fields.DocumentTitle, a descriptor object is passed
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 Name","value":"Demo fulfillment of product 1","required":"Y","default":"Demo fulfillment 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 Name","value":"Demo fulfillment of product 1","required":"Y","default":"Demo fulfillment 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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type DocumentAddResult = {
document: {
id: number
title: string
number: string
createTime: ISODate
updateTime: ISODate
createdBy: number
updatedBy: number | null
changeStampsEnabled: boolean
changeStampsDisabledReason: string
changeQrCodeEnabled: boolean
qrCodeEnabled: boolean
changeQrCodeDisabledReason: string
products: {
currencyId: string
totalSum: string
totalRows: number
}
stampsEnabled: boolean
downloadUrl: string
downloadUrlMachine: string
publicUrl: string | null
isTransformationError: boolean
transformationErrorMessage: string
transformationErrorCode: string
templateId: string
pullTag: string
emailDiskFile: number
entityTypeId: string
entityId: string
values: Record<string, unknown>
imageUrl: string
pdfUrl: string
}
}
try {
const response = await $b24.actions.v2.call.make<DocumentAddResult>({
method: 'crm.documentgenerator.document.add',
params: {
templateId: 39,
entityTypeId: 2,
entityId: 101,
values: {
DocumentNumber: '2026-001',
},
fields: {
DocumentTitle: {
title: 'Document title',
value: 'Demo product delivery 1',
required: 'Y',
default: 'Demo product delivery 1',
chain: [{}, 'getTitle'],
VALUE: 'Test via fields',
},
},
stampsEnabled: 1,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info(result.document.id, result.document.title, result.document.downloadUrl)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function addDocument() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.documentgenerator.document.add',
params: {
templateId: 39,
entityTypeId: 2,
entityId: 101,
values: {
DocumentNumber: '2026-001',
},
fields: {
DocumentTitle: {
title: 'Document title',
value: 'Demo product delivery 1',
required: 'Y',
default: 'Demo product delivery 1',
chain: [{}, 'getTitle'],
VALUE: 'Test via fields',
},
},
stampsEnabled: 1,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info(result.document.id, result.document.title, result.document.downloadUrl)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addDocument)
</script>
try {
$response = $b24Service
->core
->call(
'crm.documentgenerator.document.add',
[
'templateId' => 39,
'entityTypeId' => 2,
'entityId' => 101,
'values' => [
'DocumentNumber' => '2026-001',
],
'fields' => [
'DocumentTitle' => [
'title' => 'Document Name',
'value' => 'Demo fulfillment of product 1',
'required' => 'Y',
'default' => 'Demo fulfillment 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();
}
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.documentgenerator.document.add(
template_id=39,
entity_type_id=2,
entity_id=101,
values={
"DocumentNumber": "2026-001",
},
fields={
"DocumentTitle": {
"title": "Document Name",
"value": "Demo fulfillment of product 1",
"required": "Y",
"default": "Demo fulfillment of product 1",
"chain": [{}, "getTitle"],
"VALUE": "Test via fields",
},
},
stamps_enabled=1,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
BX24.callMethod(
'crm.documentgenerator.document.add',
{
templateId: 39,
entityTypeId: 2,
entityId: 101,
values: {
DocumentNumber: '2026-001',
},
fields: {
DocumentTitle: {
title: 'Document Name',
value: 'Demo fulfillment of product 1',
required: 'Y',
default: 'Demo fulfillment 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 Name',
'value' => 'Demo fulfillment of product 1',
'required' => 'Y',
'default' => 'Demo fulfillment 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": "The template is missing seals and signatures",
"changeQrCodeEnabled": false,
"qrCodeEnabled": false,
"changeQrCodeDisabledReason": "The template is missing a QR code",
"products": {
"currencyId": "UAH",
"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 fulfillment of product 2026-001",
"number": "2026-001",
"createTime": "2026-03-20T13:51:45+03:00",
"createdBy": 577,
"updateTime": "2026-03-20T13:51:45+03: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+03:00",
"date_finish": "2026-03-20T13:51:45+03:00",
"operating_reset_at": 1774004504,
"operating": 0.9240179061889648
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response. Returns the |
|
time |
Information about the request execution time |
Result Type
|
Name |
Description |
|
document |
Data of the created document. The structure is described in the |
Document Type
|
Name |
Description |
|
id |
Document identifier |
|
title |
Document name |
|
number |
Document number |
|
createTime |
Create date |
|
updateTime |
Update date |
|
createdBy |
Identifier of the user who created the document |
|
Identifier of the user who updated the document |
|
|
changeStampsEnabled |
Can the stamp and signature inclusion be changed |
|
changeStampsDisabledReason |
Reason why the stamp and signature inclusion cannot be changed |
|
changeQrCodeEnabled |
Can the QR code be enabled or disabled |
|
qrCodeEnabled |
Current state of the QR code |
|
changeQrCodeDisabledReason |
Reason why the QR code cannot be changed |
|
products |
Summary information about the document's products ( |
|
stampsEnabled |
Stamp and signature inclusion flag |
|
downloadUrl |
Link to download the document |
|
downloadUrlMachine |
Link to download the document for machine access |
|
Public link to the document |
|
|
isTransformationError |
Flag indicating a document conversion error |
|
transformationErrorMessage |
Text of the conversion error if |
|
transformationErrorCode |
Code of the conversion error if |
|
templateId |
Identifier of the template |
|
pullTag |
Event tag for document transformation |
|
emailDiskFile |
Identifier of the file in Drive for sending via email |
|
entityTypeId |
Identifier of the CRM object type |
|
entityId |
Identifier of the CRM object |
|
values |
Values of the document fields passed during creation |
|
imageUrl |
Link to the document image, if already created |
|
pdfUrl |
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 |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
No provider for entityTypeId |
No data provider found for the provided |
|
|
Empty required parameter "value" |
|
|
|
Cannot create document on deleted template |
Cannot create a document based on a deleted template |
|
|
Cannot create document |
Error creating document based on the template |
|
|
Access denied |
No access to create the document |
|
|
Maximum count of documents has been reached |
Exceeded the limit of documents in the plan |
|
|
Error getting next number |
Failed to get the next document number from the number generator |
|
|
Bitrix\DocumentGenerator\Template constructor must be is public |
Low-level error when calling without a valid |
|
|
Module documentgenerator is not installed |
The |
|
|
Template not found |
Template with the specified |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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
- Get Document crm.documentgenerator.document.get
- Update Document crm.documentgenerator.document.update
- Get Document Fields crm.documentgenerator.document.getfields
- Get a List of Documents crm.documentgenerator.document.list
- Delete Document crm.documentgenerator.document.delete
- Get crm.documentgenerator.template.getfields Document Template Fields
- How to Add a Template and Create a Document Based on It