Обновить документ crm.documentgenerator.document.update

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

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

Метод 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

Особенность метода

pdfUrl и imageUrl могут отсутствовать сразу после обновления, так как конвертация выполняется асинхронно. Проверяйте итоговое состояние через crm.documentgenerator.document.get

Примеры кода

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

Пример обновления документа, где:

  • id документа — 61
  • новый номер документа — 2026-002
  • подстановка печатей включена
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
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":61,"values":{"DocumentNumber":"2026-002"},"stampsEnabled":1,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.documentgenerator.document.update
        
// 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 DocumentUpdateResult = {
          document: {
            id: string
            title: string
            number: string
            createTime: ISODate
            updateTime: ISODate
            createdBy: string | null
            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
            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<DocumentUpdateResult>({
            method: 'crm.documentgenerator.document.update',
            params: {
              id: 61,
              values: {
                DocumentNumber: '2026-002',
              },
              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.number, 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 updateDocument() {
            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.update',
                params: {
                  id: 61,
                  values: {
                    DocumentNumber: '2026-002',
                  },
                  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.number, result.document.title)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateDocument)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.documentgenerator.document.update',
                    [
                        'id' => 61,
                        'values' => [
                            'DocumentNumber' => '2026-002',
                        ],
                        'stampsEnabled' => 1,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating document: ' . $e->getMessage();
        }
        
from b24pysdk.client import BaseClient
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        client: BaseClient
        
        try:
            bitrix_response = client.crm.documentgenerator.document.update(
                bitrix_id=61,
                values={
                    "DocumentNumber": "2026-002",
                },
                stamps_enabled=1,
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Ошибка Bitrix API",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Ошибка Bitrix SDK: {error.message}")
        except Exception as error:
            print(f"Непредвиденная ошибка: {error}")
        
BX24.callMethod(
            'crm.documentgenerator.document.update',
            {
                id: 61,
                values: {
                    DocumentNumber: '2026-002',
                },
                stampsEnabled: 1,
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.documentgenerator.document.update',
            [
                'id' => 61,
                'values' => [
                    'DocumentNumber' => '2026-002',
                ],
                'stampsEnabled' => 1,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

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

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

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

Тип result

Название
тип

Описание

document
object

Данные обновленного документа. Структура описана в типе document

Тип document

Название
тип

Описание

id
integer | string

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

title
string

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

number
string

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

createTime
datetime

Дата создания

updateTime
datetime

Дата обновления

createdBy
integer | string | null

Идентификатор пользователя, создавшего документ

updatedBy
integer | string | null

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

changeStampsEnabled
boolean

Можно ли изменить признак подстановки печати и подписи

changeStampsDisabledReason
string

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

changeQrCodeEnabled
boolean

Можно ли включить или выключить QR-код

qrCodeEnabled
boolean

Текущее состояние QR-кода

changeQrCodeDisabledReason
string

Причина, почему нельзя изменить QR-код

products
object

Сводная информация по товарам документа (currencyId, totalSum, totalRows)

stampsEnabled
boolean

Признак подстановки печати и подписи

downloadUrl
string

Ссылка на скачивание документа

downloadUrlMachine
string

Ссылка на скачивание документа для машинного доступа

publicUrl
string | null

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

isTransformationError
boolean

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

transformationErrorMessage
string

Текст ошибки конвертации, если isTransformationError = true

transformationErrorCode
string

Код ошибки конвертации, если isTransformationError = true

templateId
integer | string

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

pullTag
string

Тег события трансформации документа

emailDiskFile
integer

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

entityTypeId
integer | string

Идентификатор типа CRM-объекта

entityId
integer | string

Идентификатор CRM-объекта

values
object

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

imageUrl
string

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

pdfUrl
string

Ссылка на PDF-файл документа, если уже создан

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

HTTP-статус: 400

{
            "error": "DOCGEN_ACCESS_ERROR",
            "error_description": "Access denied"
        }
        

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

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

Файл шаблона поврежден или имеет неверную структуру

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

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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

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

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

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