метод REST scope: crm

crm.documentgenerator.document.upload

Загрузить документ

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

Описание

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

Подробнее: Как загружать файлы

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

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

Ответ

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

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

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

HTTP-статус: 400

{
    "error": "100",
    "error_description": "Invalid value {} to match with parameter {fields}. Should be value of type array."
}
Код Описание Значение
100 Could not find value for parameter {fields} Не передан обязательный параметр 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 недоступен

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