Изменить существующий документ documentgenerator.document.update

Scope: documentgenerator

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

Метод documentgenerator.document.update обновляет документ новыми значениями полей.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

id*
integer

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

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

values
object

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

stampsEnabled
integer

Режим печатей и подписей:

  • 1 — включить
  • 0 — выключить

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

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 '{"id":51,"values":{"DocumentNumber":"ДГ-2026-001","CurrentDate":"2026-03-20T00:00:00+03:00","ClientName":"ООО Ромашка","ClientPhone":"+7 999 123-45-67","Total":"130000","Comment":"Оплата в течение 3 рабочих дней после подписания","UserName":"Иван Петров"},"stampsEnabled":1}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.document.update
        
curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"id":51,"values":{"DocumentNumber":"ДГ-2026-001","CurrentDate":"2026-03-20T00:00:00+03:00","ClientName":"ООО Ромашка","ClientPhone":"+7 999 123-45-67","Total":"130000","Comment":"Оплата в течение 3 рабочих дней после подписания","UserName":"Иван Петров"},"stampsEnabled":1,"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/documentgenerator.document.update
        
try
        {
            const response = await $b24.callMethod(
                'documentgenerator.document.update',
                {
                    id: 51,
                    values: {
                        DocumentNumber: 'ДГ-2026-001',
                        CurrentDate: '2026-03-20T00:00:00+03:00',
                        ClientName: 'ООО Ромашка',
                        ClientPhone: '+7 999 123-45-67',
                        Total: '130000',
                        Comment: 'Оплата в течение 3 рабочих дней после подписания',
                        UserName: 'Иван Петров'
                    },
                    stampsEnabled: 1
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }
        
try {
            $response = $b24Service->core->call(
                'documentgenerator.document.update',
                [
                    'id' => 51,
                    'values' => [
                        'DocumentNumber' => 'ДГ-2026-001',
                        'CurrentDate' => '2026-03-20T00:00:00+03:00',
                        'ClientName' => 'ООО Ромашка',
                        'ClientPhone' => '+7 999 123-45-67',
                        'Total' => '130000',
                        'Comment' => 'Оплата в течение 3 рабочих дней после подписания',
                        'UserName' => 'Иван Петров',
                    ],
                    'stampsEnabled' => 1,
                ]
            );
        
            $result = $response->getResponseData()->getResult();
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        
BX24.callMethod(
            'documentgenerator.document.update',
            {
                id: 51,
                values: {
                    DocumentNumber: 'ДГ-2026-001',
                    CurrentDate: '2026-03-20T00:00:00+03:00',
                    ClientName: 'ООО Ромашка',
                    ClientPhone: '+7 999 123-45-67',
                    Total: '130000',
                    Comment: 'Оплата в течение 3 рабочих дней после подписания',
                    UserName: 'Иван Петров'
                },
                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.update',
            [
                'id' => 51,
                'values' => [
                    'DocumentNumber' => 'ДГ-2026-001',
                    'CurrentDate' => '2026-03-20T00:00:00+03:00',
                    'ClientName' => 'ООО Ромашка',
                    'ClientPhone' => '+7 999 123-45-67',
                    'Total' => '130000',
                    'Comment' => 'Оплата в течение 3 рабочих дней после подписания',
                    'UserName' => 'Иван Петров',
                ],
                'stampsEnabled' => 1,
            ]
        );
        
        print_r($result);

Обработка ответа

HTTP-статус: 200

{
            "result": {
                "document": {
                    "downloadUrl": "/bitrix/services/main/ajax.php?action=documentgenerator.api.document.getfile&SITE_ID=s1&id=51&ts=1773844068",
                    "publicUrl": "https://mysite.ru/~bat5R",
                    "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,
                        "CurrentDate": "2026-03-20T00:00:00+03:00",
                        "ClientName": "ООО Ромашка",
                        "ClientPhone": "+7 999 123-45-67",
                        "Total": "130000",
                        "Comment": "Оплата в течение 5 рабочих дней после подписания",
                        "UserName": "Иван Петров"
                    },
                    "publicUrlView": {
                        "time": "2026-03-19T15:08:05+03:00"
                    },
                    "templateId": "53",
                    "provider": "Bitrix\\DocumentGenerator\\DataProvider\\Rest",
                    "pullTag": "TRANSFORMDOCUMENT51",
                    "imageUrl": "/bitrix/services/main/ajax.php?action=documentgenerator.api.document.getimage&SITE_ID=s1&id=51&ts=1773844068",
                    "pdfUrl": "/bitrix/services/main/ajax.php?action=documentgenerator.api.document.getpdf&SITE_ID=s1&id=51&ts=1773844068",
                    "printUrl": "/bitrix/services/main/ajax.php?action=documentgenerator.api.document.showpdf&SITE_ID=s1&id=51&print=y&ts=1773844068",
                    "emailDiskFile": 5573,
                    "downloadUrlMachine": "https://mysite.ru/rest/documentgenerator.api.document.getfile.json?auth=1fe8bb690000071b00000844000001f7f0f107826a2f4f01a384d1dcdb624764d8ea63&token=documentgenerator%7CYWN0aW9uPWRvY3VtZW50Z2VuZXJhdG9yLmFwaS5kb2N1bWVudC5nZXRmaWxlJlNJVEVfSUQ9czEmaWQ9NTEmdHM9MTc3Mzg0NDA2OCZfPVptQjFqSzNTNlhtMm5EbUR6OFV6YlJydExGbGtaOGpF%7CImRvY3VtZW50Z2VuZXJhdG9yLmFwaS5kb2N1bWVudC5nZXRmaWxlfGRvY3VtZW50Z2VuZXJhdG9yfFlXTjBhVzl1UFdSdlkzVnRaVzUwWjJWdVpYSmhkRzl5TG1Gd2FTNWtiMk4xYldWdWRDNW5aWFJtYVd4bEpsTkpWRVZmU1VROWN6RW1hV1E5TlRFbWRITTlNVGMzTXpnME5EQTJPQ1pmUFZwdFFqRnFTek5UTmxodE1tNUViVVI2T0ZWNllsSnlkRXhHYkd0YU9HcEZ8MWZlOGJiNjkwMDAwMDcxYjAwMDAwODQ0MDAwMDAxZjdmMGYxMDc4MjZhMmY0ZjAxYTM4NGQxZGNkYjYyNDc2NGQ4ZWE2MyI%3D.Cifk0KKcqbktmPy6ARfXPn7dO71%2FP4MY5xys1%2FGF%2FBc%3D",
                    "imageUrlMachine": "https://mysite.ru/rest/documentgenerator.api.document.getimage.json?auth=1fe8bb690000071b00000844000001f7f0f107826a2f4f01a384d1dcdb624764d8ea63&token=documentgenerator%7CYWN0aW9uPWRvY3VtZW50Z2VuZXJhdG9yLmFwaS5kb2N1bWVudC5nZXRpbWFnZSZTSVRFX0lEPXMxJmlkPTUxJnRzPTE3NzM4NDQwNjgmXz1GOTV5aUg2SnN2UTlrZjRnQnNBN2Z6NXpxVjIxSzB1Zg%3D%3D%7CImRvY3VtZW50Z2VuZXJhdG9yLmFwaS5kb2N1bWVudC5nZXRpbWFnZXxkb2N1bWVudGdlbmVyYXRvcnxZV04wYVc5dVBXUnZZM1Z0Wlc1MFoyVnVaWEpoZEc5eUxtRndhUzVrYjJOMWJXVnVkQzVuWlhScGJXRm5aU1pUU1ZSRlgwbEVQWE14Sm1sa1BUVXhKblJ6UFRFM056TTRORFF3TmpnbVh6MUdPVFY1YVVnMlNuTjJVVGxyWmpSblFuTkJOMlo2TlhweFZqSXhTekIxWmc9PXwxZmU4YmI2OTAwMDAwNzFiMDAwMDA4NDQwMDAwMDFmN2YwZjEwNzgyNmEyZjRmMDFhMzg0ZDFkY2RiNjI0NzY0ZDhlYTYzIg%3D%3D.r2wwtKof5kdIyUr8xek%2B8XThT4RG48ZMcLABVjsa0Zk%3D",
                    "pdfUrlMachine": "https://mysite.ru/rest/documentgenerator.api.document.getpdf.json?auth=1fe8bb690000071b00000844000001f7f0f107826a2f4f01a384d1dcdb624764d8ea63&token=documentgenerator%7CYWN0aW9uPWRvY3VtZW50Z2VuZXJhdG9yLmFwaS5kb2N1bWVudC5nZXRwZGYmU0lURV9JRD1zMSZpZD01MSZ0cz0xNzczODQ0MDY4Jl89UnUxUGRvM2RWV0xXTEhXZDhhNW9VeThDTlVsWlJTd3M%3D%7CImRvY3VtZW50Z2VuZXJhdG9yLmFwaS5kb2N1bWVudC5nZXRwZGZ8ZG9jdW1lbnRnZW5lcmF0b3J8WVdOMGFXOXVQV1J2WTNWdFpXNTBaMlZ1WlhKaGRHOXlMbUZ3YVM1a2IyTjFiV1Z1ZEM1blpYUndaR1ltVTBsVVJWOUpSRDF6TVNacFpEMDFNU1owY3oweE56Y3pPRFEwTURZNEpsODlVblV4VUdSdk0yUldWMHhYVEVoWFpEaGhOVzlWZVRoRFRsVnNXbEpUZDNNPXwxZmU4YmI2OTAwMDAwNzFiMDAwMDA4NDQwMDAwMDFmN2YwZjEwNzgyNmEyZjRmMDFhMzg0ZDFkY2RiNjI0NzY0ZDhlYTYzIg%3D%3D.u%2Bkuio%2FsYEU93FKvdsODqjyEAZ7WpP0M9We%2BurZvjUk%3D",
                    "printUrlMachine": "https://mysite.ru/rest/documentgenerator.api.document.showpdf.json?auth=1fe8bb690000071b00000844000001f7f0f107826a2f4f01a384d1dcdb624764d8ea63&token=documentgenerator%7CYWN0aW9uPWRvY3VtZW50Z2VuZXJhdG9yLmFwaS5kb2N1bWVudC5zaG93cGRmJlNJVEVfSUQ9czEmaWQ9NTEmcHJpbnQ9eSZ0cz0xNzczODQ0MDY4Jl89cXFmSUhjODk1MTI4RXRWQXE3Nk5UNEdzN1dHWTlZdjU%3D%7CImRvY3VtZW50Z2VuZXJhdG9yLmFwaS5kb2N1bWVudC5zaG93cGRmfGRvY3VtZW50Z2VuZXJhdG9yfFlXTjBhVzl1UFdSdlkzVnRaVzUwWjJWdVpYSmhkRzl5TG1Gd2FTNWtiMk4xYldWdWRDNXphRzkzY0dSbUpsTkpWRVZmU1VROWN6RW1hV1E5TlRFbWNISnBiblE5ZVNaMGN6MHhOemN6T0RRME1EWTRKbDg5Y1hGbVNVaGpPRGsxTVRJNFJYUldRWEUzTms1VU5FZHpOMWRIV1RsWmRqVT18MWZlOGJiNjkwMDAwMDcxYjAwMDAwODQ0MDAwMDAxZjdmMGYxMDc4MjZhMmY0ZjAxYTM4NGQxZGNkYjYyNDc2NGQ4ZWE2MyI%3D.s%2F4zPE4fPTMvZImi5pumUXn5s0oB5nwVbw3rFIM34eo%3D"
                }
            },
            "time": {
                "start": 1773922099,
                "finish": 1773922099.372946,
                "duration": 0.37294602394104004,
                "processing": 0,
                "date_start": "2026-03-19T15:08:19+03:00",
                "date_finish": "2026-03-19T15:08:19+03:00",
                "operating_reset_at": 1773922699,
                "operating": 0.13009309768676758
            }
        }

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

Название
тип

Описание

result
object

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

time
time

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

Объект result

Название
тип

Описание

document
object

Данные обновленного документа (подробное описание)

Объект document

Название
тип

Описание

id
string

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

title
string

Название документа

number
string

Номер документа

templateId
string

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

provider
string

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

value
string

Внешний идентификатор объекта

fileId
integer

Идентификатор DOCX-файла на Диске

imageId
integer

Идентификатор изображения предпросмотра на Диске

pdfId
integer

Идентификатор PDF-файла на Диске

values
object

Значения полей документа (подробное описание)

stampsEnabled
boolean

Признак включенных печатей и подписей

downloadUrl
string

Ссылка на скачивание DOCX для пользователя

pdfUrl
string

Ссылка на скачивание PDF для пользователя

imageUrl
string

Ссылка на изображение предпросмотра для пользователя

printUrl
string

Ссылка на печатную форму PDF для пользователя

downloadUrlMachine
string

Ссылка на скачивание DOCX для приложения

pdfUrlMachine
string

Ссылка на скачивание PDF для приложения

imageUrlMachine
string

Ссылка на изображение предпросмотра для приложения

printUrlMachine
string

Ссылка на печатную форму PDF для приложения

publicUrl
string

Публичная ссылка на документ, если она включена

publicUrlView
object

Параметры публичной ссылки (подробное описание)

isTransformationError
boolean

Признак ошибки конвертации документа

pullTag
string

Тег для подписки на обновление статуса конвертации

emailDiskFile
integer

Идентификатор файла на Диске для отправки по почте

createTime
datetime

Время создания документа

updateTime
datetime

Время последнего обновления документа

createdBy
string

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

updatedBy
integer

Идентификатор пользователя, который обновил документ

Объект values

Название
тип

Описание

productsTableVariant
string

Вариант отображения таблицы товаров

_creationMethod
string

Способ создания документа

stampsEnabled
boolean

Признак включенных печатей и подписей

<код_поля>
string

Значение поля из шаблона по его коду

Объект publicUrlView

Название
тип

Описание

time
datetime

Дата и время, до которых действует публичная ссылка

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

HTTP-статус: 400

{
            "error": "0",
            "error_description": "Документ не найден"
        }

Название
тип

Описание

error
string

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

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Статус

Код

Описание

Значение

400

100

Bitrix\DocumentGenerator\Document constructor must be is public

Не передан обязательный параметр id

400

0

Документ не найден

Документ с указанным id не найден

400

0

You do not have permissions to view documents

Недостаточно прав на изменение документа

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Создать новый документ
Следующая
Получить документ по идентификатору