Create a New Document Based on a Template documentgenerator.document.add
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
documentgeneratorWho can execute the method: a user with document creation permissions
The method documentgenerator.document.add creates a new document based on a template.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
templateId* |
Template identifier. You can obtain the template identifier after creating a template or by using the get template list method. |
|
providerClassName |
Data provider class. When called via REST, |
|
value* |
External identifier of the object for which the document is being generated. The format of Recommended format:
Examples of
Examples of
|
|
values |
Field values of the document in the format |
|
stampsEnabled |
Seal and signature mode:
Defaults to the value from the template |
|
fields |
Description of how to interpret and format values from The key of the If you are only passing plain text, this parameter can be omitted. Example structure of
|
Parameter fields
|
Name |
Description |
|
TYPE |
Field type. Types for which formatting can be specified:
|
|
FORMAT |
Formatting parameters for the field type.
For For
User Documentation |
|
PROVIDER |
Provider class |
|
TITLE |
Field title |
Code Examples
How to Use Examples in Documentation
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+01:00","ClientName":"ABC Corp","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+01:00","ClientName":"ABC Corp","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
// 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
templateId: string
provider: string
value: string
values: Record<string, unknown>
stampsEnabled: boolean
downloadUrl: string
downloadUrlMachine: string
publicUrl: string | null
isTransformationError: boolean
pullTag: string
emailDiskFile: number
createTime: ISODate
updateTime: ISODate
createdBy: number
updatedBy: number | null
}
}
try {
const response = await $b24.actions.v2.call.make<DocumentAddResult>({
method: 'documentgenerator.document.add',
params: {
templateId: 53,
value: 'SUPPLY_CONTRACT_2026_015',
values: {
DocumentNumber: 'DG-2026-001',
CurrentDate: '2026-03-18T00:00:00+03:00',
ClientName: 'Romashka LLC',
ClientPhone: '+49 999 123-45-67',
Total: '125000',
Comment: 'Payment within 5 business days after signing',
UserName: 'Ivan Petrov',
},
fields: {
CurrentDate: {
TYPE: 'DATE',
FORMAT: {
format: 'd.m.Y',
},
TITLE: 'Contract date',
},
},
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('Created document id:', result.document.id, 'title:', result.document.title)
}
} 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: 'documentgenerator.document.add',
params: {
templateId: 53,
value: 'SUPPLY_CONTRACT_2026_015',
values: {
DocumentNumber: 'DG-2026-001',
CurrentDate: '2026-03-18T00:00:00+03:00',
ClientName: 'Romashka LLC',
ClientPhone: '+49 999 123-45-67',
Total: '125000',
Comment: 'Payment within 5 business days after signing',
UserName: 'Ivan Petrov',
},
fields: {
CurrentDate: {
TYPE: 'DATE',
FORMAT: {
format: 'd.m.Y',
},
TITLE: 'Contract date',
},
},
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('Created document id:', result.document.id, 'title:', result.document.title)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addDocument)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.documentgenerator.document.add(
template_id=53,
value="SUPPLY_CONTRACT_2026_015",
values={
"DocumentNumber": "DG-2026-001",
"CurrentDate": "2026-03-18T00:00:00+03:00",
"ClientName": "Müller GmbH",
"ClientPhone": "+49 999 123-45-67",
"Total": "125000",
"Comment": "Payment within 5 business days after signing",
"UserName": "Klaus Weber",
},
fields={
"CurrentDate": {
"TYPE": "DATE",
"FORMAT": {
"format": "d.m.Y",
},
"TITLE": "Contract date",
},
},
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}")
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+01:00',
'ClientName' => 'ABC Corp',
'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+01:00',
ClientName: 'ABC Corp',
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+01:00',
'ClientName' => 'ABC Corp',
'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);
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "documentgenerator.document.add", b24.Params{
"templateId": 53,
"value": "SUPPLY_CONTRACT_2026_015",
"values": b24.Params{
"DocumentNumber": "SC-2026-001",
"CurrentDate": "2026-03-18T00:00:00+03:00",
"ClientName": "ABC Corp",
"ClientPhone": "+49 999 123-45-67",
"Total": "125000",
"Comment": "Payment within 5 business days after signing",
"UserName": "John Smith",
},
"fields": b24.Params{
"CurrentDate": b24.Params{
"TYPE": "DATE",
"FORMAT": b24.Params{
"format": "d.m.Y",
},
"TITLE": "Contract Date",
},
},
"stampsEnabled": 1,
})
if err != nil {
return fmt.Errorf("documentgenerator.document.add: %w", err)
}
// The method wraps the response in an object with the "document" key.
raw, ok := b24.Unwrap(res.Result, "document")
if !ok {
return fmt.Errorf("no document key in the response")
}
var item struct {
DownloadUrl string `json:"downloadUrl"`
Title string `json:"title"`
Number string `json:"number"`
ID b24.ID `json:"id"`
CreateTime string `json:"createTime"`
CreatedBy int `json:"createdBy"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.DownloadUrl, item.Title)
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+01:00",
"createdBy": 503,
"updateTime": "2026-03-18T17:27:48+01: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+01:00",
"ClientName": "ABC Corp",
"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+01:00",
"date_finish": "2026-03-18T17:27:48+01:00",
"operating_reset_at": 1773844668,
"operating": 0.9536302089691162
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response (detailed description) |
|
time |
Information about the request execution time |
Object result
|
Name |
Description |
|
document |
Data of the created document (detailed description) |
Object document
|
Name |
Description |
|
id |
Document identifier |
|
title |
Document title |
|
number |
Document number |
|
templateId |
Template identifier |
|
provider |
Data provider class |
|
value |
External identifier of the object |
|
values |
Field values of the document (detailed description) |
|
stampsEnabled |
Indicator of enabled seals and signatures |
|
downloadUrl |
Link to download DOCX for the user |
|
downloadUrlMachine |
Link to download DOCX for the application |
|
publicUrl |
Public link to the document, if enabled |
|
isTransformationError |
Indicator of document conversion error |
|
pullTag |
Tag for subscribing to conversion status updates |
|
emailDiskFile |
File identifier on Drive for sending by e-mail |
|
createTime |
Document creation time |
|
updateTime |
Last update time of the document |
|
createdBy |
Identifier of the document author |
|
updatedBy |
Identifier of the user who updated the document |
Object values
|
Name |
Description |
|
_creationMethod |
Method of document creation |
|
stampsEnabled |
Indicator of enabled seals and signatures |
|
<field_code> |
Field value from the template by its code |
File conversion to PDF is performed asynchronously. The pdfUrl field is returned in the response only after the PDF has been generated, so it is usually absent immediately after the document is created. To check the conversion result, re-invoke documentgenerator.document.get.
Error Handling
HTTP Status: 400, 403
{
"error": "0",
"error_description": "Cannot create document on deleted template"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
Bitrix\DocumentGenerator\Template constructor must be is public |
Required parameter |
|
|
|
Empty required parameter "value" |
Required parameter |
|
|
|
Cannot create document on deleted template |
Cannot create a document based on a deleted template |
|
|
|
Template not found |
No template exists with the specified |
|
|
|
Cannot create document |
Failed to create document |
|
|
|
You do not have permissions to view documents |
Insufficient permissions to view documents |
|
|
|
Maximum count of documents has been reached |
Document limit reached on the plan |
|
|
|
Access denied |
Insufficient permissions to create document |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it 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
- Update Existing Document documentgenerator.document.update
- Get Document by ID documentgenerator.document.get
- Get the List of Documents documentgenerator.document.list
- Delete document documentgenerator.document.delete
- Enable or disable public link for document documentgenerator.document.enablepublicurl
- Get the list of fields for the document documentgenerator.document.getfields