метод REST scope: crm

crm.documentgenerator.document.update

Обновить документ

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

Описание

Метод crm.documentgenerator.document.update обновляет существующий документ.

Параметры

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

Идентификатор документа

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

Объект со значениями полей документа.

Формат:

{
    "field_1": "value_1",
    "field_2": "value_2"
}

где:
- field_n — код поля документа
- value_n — значение поля

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

Посмотреть поля можно методом crm.documentgenerator.document.getfields

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

Подставлять печать и подпись:
- 1 — подставлять
- 0 — не подставлять

По умолчанию 1

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":61,"values":{"DocumentNumber":"2026-002"},"stampsEnabled":1}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.documentgenerator.document.update

Ответ

HTTP-статус: 200

{
    "result": {
        "document": {
            "changeStampsEnabled": false,
            "changeStampsDisabledReason": "В шаблоне нет печатей и подписей",
            "changeQrCodeEnabled": false,
            "qrCodeEnabled": false,
            "changeQrCodeDisabledReason": "В шаблоне нет QR-кода",
            "products": {
                "currencyId": "UAH",
                "totalSum": "0.00",
                "totalRows": 0
            },
            "downloadUrl": "https://bitrix.bitrix24.ru/bitrix/services/main/ajax.php?action=crm.documentgenerator.document.download&SITE_ID=s1&id=61",
            "publicUrl": null,
            "title": "Демонстрационная реализация товара 2026-001",
            "number": "2026-002",
            "id": "61",
            "createTime": "2026-03-20T14:42:39+03:00",
            "createdBy": null,
            "updateTime": "2026-03-20T14:42:38+03:00",
            "updatedBy": 577,
            "stampsEnabled": true,
            "isTransformationError": false,
            "values": {
                "productsTableVariant": "",
                "_creationMethod": "rest",
                "stampsEnabled": true,
                "DocumentNumber": "2026-002"
            },
            "templateId": "39",
            "pullTag": "TRANSFORMDOCUMENT61",
            "imageUrl": "https://bitrix.bitrix24.ru/bitrix/services/main/ajax.php?action=crm.documentgenerator.document.getImage&SITE_ID=s1&id=61",
            "pdfUrl": "https://bitrix.bitrix24.ru/bitrix/services/main/ajax.php?action=crm.documentgenerator.document.getPdf&SITE_ID=s1&id=61",
            "emailDiskFile": 5611,
            "entityId": "101",
            "entityTypeId": "2",
            "downloadUrlMachine": "https://bitrix.bitrix24.ru/rest/crm.documentgenerator.document.download.json?..."
        }
    },
    "time": {
        "start": 1774006958,
        "finish": 1774006960.122164,
        "duration": 2.122164011001587,
        "processing": 2,
        "date_start": "2026-03-20T14:42:38+03:00",
        "date_finish": "2026-03-20T14:42:40+03:00",
        "operating_reset_at": 1774007558,
        "operating": 1.9965031147003174
    }
}

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

result object

Корневой элемент ответа. Возвращает объект result

time time

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

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

HTTP-статус: 400

{
    "error": "DOCGEN_ACCESS_ERROR",
    "error_description": "Access denied"
}
Код Описание Значение
100 Bitrix\\DocumentGenerator\\Document constructor must be is public Не передан обязательный параметр id
DOCGEN_ACCESS_ERROR Access denied Нет доступа к документу
0 Документ не найден Документ с указанным id не найден или недоступен
0 Document not found Документ не относится к модулю CRM
0 You do not have permissions to modify this document Недостаточно прав для изменения документа
0 Module documentgenerator is not installed Модуль documentgenerator недоступен
0 Cant update not saved document Попытка обновить несохраненный документ
0 DOCUMENT_FILE_NOT_PROCESSABLE_ERROR Файл шаблона поврежден или имеет неверную структуру

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

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