метод REST scope: documentgenerator

documentgenerator.document.add

Создать новый документ на основании шаблона

Кто может выполнять: пользователь с правом на создание документов

Описание

Метод documentgenerator.document.add создает новый документ на основании шаблона.

Параметры

templateId integer обязательный

Идентификатор шаблона.

Получить идентификатор шаблона можно после создания шаблона или методом получения списка шаблонов

providerClassName string необязательный

Класс провайдера данных.

При вызове через REST всегда используется Bitrix\DocumentGenerator\DataProvider\Rest: переданное значение игнорируется, поэтому параметр можно не указывать

value string обязательный

Внешний идентификатор объекта, для которого формируется документ.

Формат value задается интеграцией. Используйте единый формат в рамках вашего приложения, чтобы искать и фильтровать документы.

Рекомендуемый формат: <ТИП_ОБЪЕКТА>_<ID>, где:
- <ТИП_ОБЪЕКТА> — строковый код типа объекта в верхнем регистре
- <ID> — числовой или строковый идентификатор объекта во внешней системе

Примеры значений value для CRM-объектов:
- лид — LEAD_123
- контакт — CONTACT_45
- компания — COMPANY_78
- сделка — DEAL_901
- коммерческое предложение — QUOTE_55
- счет — INVOICE_12

Примеры значений value для другие объектов:
- заказ — ORDER_1024
- договор поставки — SUPPLY_CONTRACT_2026_015
- запись внешней системы — ERP_DOC_A-7741

values object необязательный

Значения полей документа вида {"КодПоля":"Значение"}

stampsEnabled integer необязательный

Режим печатей и подписей:
- 1 — включить
- 0 — выключить

По умолчанию берется значение из шаблона

fields object необязательный

Описание того, как интерпретировать и форматировать значения из values (подробное описание).

Ключ объекта fields должен совпадать с кодом поля из шаблона.

Если передаете только обычный текст, параметр можно не указывать.

Пример структуры fields:

{
    "CurrentDate": {
        "TYPE": "DATE",
        "FORMAT": {
            "format": "d.m.Y"
        },
        "TITLE": "Дата договора"
    }
}

Параметр fields

TYPE string необязательный

Тип поля.

Типы, для которых можно указать форматирование:
- DATE — дата или дата-время
- NAME — ФИО

FORMAT object необязательный

Параметры формата для типа поля.

FORMAT не фиксирован одним значением, его нужно выбирать под ваш шаблон и требования к выводу.

Для DATE значение format задается в формате модификаторов даты генератора документов. Пример: {"format":"d.m.Y"}

Для NAME:
- format задает шаблон вывода частей имени, например #NAME# #LAST_NAME#
- case задает падеж

Пользовательская документация

PROVIDER string необязательный

Класс провайдера

TITLE string необязательный

Название поля

Примеры запроса

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"templateId":53,"value":"SUPPLY_CONTRACT_2026_015","values":{"DocumentNumber":"ДГ-2026-001","CurrentDate":"2026-03-18T00:00:00+03:00","ClientName":"ООО Ромашка","ClientPhone":"+7 999 123-45-67","Total":"125000","Comment":"Оплата в течение 5 рабочих дней после подписания","UserName":"Иван Петров"},"fields":{"CurrentDate":{"TYPE":"DATE","FORMAT":{"format":"d.m.Y"},"TITLE":"Дата договора"}},"stampsEnabled":1}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.document.add

Ответ

HTTP-статус: 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 ДГ-2026-001",
            "number": "ДГ-2026-001",
            "id": 51,
            "createTime": "2026-03-18T17:27:48+03:00",
            "createdBy": 503,
            "updateTime": "2026-03-18T17:27:48+03:00",
            "updatedBy": null,
            "stampsEnabled": true,
            "isTransformationError": false,
            "value": "SUPPLY_CONTRACT_2026_015",
            "values": {
                "productsTableVariant": "",
                "_creationMethod": "rest",
                "stampsEnabled": true,
                "DocumentNumber": "ДГ-2026-001",
                "CurrentDate": "2026-03-18T00:00:00+03:00",
                "ClientName": "ООО Ромашка",
                "ClientPhone": "+7 999 123-45-67",
                "Total": "125000",
                "Comment": "Оплата в течение 5 рабочих дней после подписания",
                "UserName": "Иван Петров"
            },
            "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+03:00",
        "date_finish": "2026-03-18T17:27:48+03:00",
        "operating_reset_at": 1773844668,
        "operating": 0.9536302089691162
    }
}

Возвращаемые данные

result object

Корневой элемент ответа (подробное описание)

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": "0",
    "error_description": "Cannot create document on deleted template"
}
Код Описание Значение
400 100 Bitrix\DocumentGenerator\Template constructor must be is public
400 0 Empty required parameter "value"
400 0 Cannot create document on deleted template
400 0 Шаблон не найден
400 0 Cannot create document
400 0 You do not have permissions to view documents
400 0 Maximum count of documents has been reached
403 DOCGEN_ACCESS_ERROR Access denied

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.