Загрузить документ crm.documentgenerator.document.upload

Scope: crm

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

Метод crm.documentgenerator.document.upload загружает готовый документ и прикрепляет его к CRM-объекту.

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

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

Название `тип`	Описание
fields^* `object`	Объект с параметрами загрузки документа (подробнее)

Параметр fields

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

Название `тип`	Описание
entityTypeId^* `integer`	Идентификатор типа CRM-объекта. Типичные значения: `1` — лид `2` — сделка `3` — контакт `4` — компания `7` — коммерческое предложение Для смарт-процессов передается их `entityTypeId`, например `177`
entityId^* `integer`	Идентификатор CRM-объекта, к которому прикрепляется документ
fileContent^* `string`	Содержимое DOCX-файла в формате base64. Подробнее: Как загружать файлы
region^* `string`	Код региона шаблона, например `ru`
title^* `string`	Название документа
number^* `string`	Номер документа
pdfContent `string`	Содержимое PDF-файла в формате base64. Подробнее: Как загружать файлы
imageContent `string`	Содержимое изображения в формате base64. Подробнее: Как загружать файлы

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

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

Примеры кода

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

Пример загрузки документа, где:

entityTypeId — 2 (сделка)
entityId — 101
region — ru
название документа — Демонстрационная реализация товара
номер документа — 2026-001

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"entityTypeId":2,"entityId":101,"fileContent":"**base64_docx_content**","region":"ru","title":"Демонстрационная реализация товара","number":"2026-001","pdfContent":"**base64_pdf_content**","imageContent":"**base64_image_content**"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.documentgenerator.document.upload

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"entityTypeId":2,"entityId":101,"fileContent":"**base64_docx_content**","region":"ru","title":"Демонстрационная реализация товара","number":"2026-001","pdfContent":"**base64_pdf_content**","imageContent":"**base64_image_content**"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.documentgenerator.document.upload

try
        {
        		const response = await $b24.callMethod(
        			'crm.documentgenerator.document.upload',
        			{
        				fields: {
        					entityTypeId: 2,
        					entityId: 101,
        					fileContent: '**base64_docx_content**',
        					region: 'ru',
        					title: 'Демонстрационная реализация товара',
        					number: '2026-001',
        					pdfContent: '**base64_pdf_content**',
        					imageContent: '**base64_image_content**',
        				},
        			}
        		);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.documentgenerator.document.upload',
                    [
                        'fields' => [
                            'entityTypeId' => 2,
                            'entityId' => 101,
                            'fileContent' => '**base64_docx_content**',
                            'region' => 'ru',
                            'title' => 'Демонстрационная реализация товара',
                            'number' => '2026-001',
                            'pdfContent' => '**base64_pdf_content**',
                            'imageContent' => '**base64_image_content**',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error uploading document: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.documentgenerator.document.upload',
            {
                fields: {
                    entityTypeId: 2,
                    entityId: 101,
                    fileContent: '**base64_docx_content**',
                    region: 'ru',
                    title: 'Демонстрационная реализация товара',
                    number: '2026-001',
                    pdfContent: '**base64_pdf_content**',
                    imageContent: '**base64_image_content**',
                },
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.documentgenerator.document.upload',
            [
                'fields' => [
                    'entityTypeId' => 2,
                    'entityId' => 101,
                    'fileContent' => '**base64_docx_content**',
                    'region' => 'ru',
                    'title' => 'Демонстрационная реализация товара',
                    'number' => '2026-001',
                    'pdfContent' => '**base64_pdf_content**',
                    'imageContent' => '**base64_image_content**',
                ],
            ]
        );
        
        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=63",
                    "publicUrl": null,
                    "title": "Демонстрационная реализация товара",
                    "number": "2026-001",
                    "id": "63",
                    "createTime": "2026-03-20T17:08:24+03:00",
                    "createdBy": "577",
                    "updateTime": "2026-03-20T17:08:24+03:00",
                    "updatedBy": null,
                    "stampsEnabled": false,
                    "isTransformationError": false,
                    "values": {
                        "productsTableVariant": "",
                        "_creationMethod": "rest"
                    },
                    "templateId": "55",
                    "pullTag": "TRANSFORMDOCUMENT63",
                    "emailDiskFile": 5619,
                    "entityId": "101",
                    "entityTypeId": "2",
                    "downloadUrlMachine": "https://bitrix.bitrix24.ru/rest/crm.documentgenerator.document.download.json?auth=***&token=***"
                }
            },
            "time": {
                "start": 1774015704,
                "finish": 1774015705.08562,
                "duration": 1.0856199264526367,
                "processing": 1,
                "date_start": "2026-03-20T17:08:24+03:00",
                "date_finish": "2026-03-20T17:08:25+03:00",
                "operating_reset_at": 1774016304,
                "operating": 1.0284008979797363
            }
        }

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

Название `тип`	Описание
result `object`	Корневой объект ответа. Содержит структуру `result`
time `time`	Информация о времени выполнения запроса

Тип result

Название `тип`	Описание
document `object`	Данные загруженного документа. Структура описана в типе `document`

Тип document

Название `тип`	Описание
id `integer` \| `string`	Идентификатор документа
title `string`	Название документа
number `string`	Номер документа
createTime `datetime`	Дата создания
updateTime `datetime`	Дата обновления
createdBy `integer` \| `string`	Идентификатор пользователя, создавшего документ
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` \| `null`	Значения полей документа
imageUrl `string`	Ссылка на изображение документа, если уже создано
pdfUrl `string`	Ссылка на PDF-файл документа, если уже создан
imageUrlMachine `string`	Ссылка на изображение документа для машинного доступа
pdfUrlMachine `string`	Ссылка на PDF-документ для машинного доступа

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

HTTP-статус: 400

{
            "error": "100",
            "error_description": "Invalid value {} to match with parameter {fields}. Should be value of type array."
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код	Описание	Значение
`100`	Could not find value for parameter	Не передан обязательный параметр `fields`
`100`	Invalid value {} to match with parameter {fields}. Should be value of type array.	Параметр `fields` передан не в формате объекта
`0`	Empty required fields: entityTypeId, fileContent, region, entityId	Не переданы обязательные поля в `fields`
`0`	Empty required fields: fileContent	Не передано обязательное поле `fields.fileContent`
`0`	Wrong "entityTypeId" field value	Передан некорректный `fields.entityTypeId`
`0`	No provider for entityTypeId	Для `fields.entityTypeId` не найден подходящий CRM-провайдер
`0`	Wrong "entityId" field value	Передан некорректный `fields.entityId`
`0`	Missing file content	Не передан или не прочитан `fields.fileContent`
`0`	Could not save file	Не удалось сохранить загруженный файл
`0`	Module crm is not installed	Модуль `crm` недоступен на этапе DG-обработки
`0`	Wrong provider ...	Некорректно определен провайдер документа
`0`	Application not found	Не удалось определить текущее REST-приложение
`0`	Error generating file for template	Не удалось создать служебный файл для скрытого шаблона
`0`	Error getting template	Не удалось получить или создать скрытый шаблон для загрузки
`Пустое значение`	You do not have permissions to view documents	Недостаточно прав на просмотр документов
`Пустое значение`	Module documentgenerator is not installed	Модуль `documentgenerator` недоступен

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

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

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

Включить или выключить публичную ссылку на документ

Получить поля документа

Загрузить документ crm.documentgenerator.document.upload

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

Параметр fieldsПараметр fields

Примеры кодаПримеры кода

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

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

Тип resultТип result

Тип documentТип document

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

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

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

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