Получить документ crm.documentgenerator.document.get

Scope: crm

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

Метод crm.documentgenerator.document.get возвращает данные документа по его идентификатору.

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

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

Название `тип`	Описание
id^* `integer`	Идентификатор документа

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

pdfUrl и imageUrl могут отсутствовать сразу после создания или обновления документа, так как конвертация выполняется асинхронно. Если ссылки нужны сразу, повторите запрос через 30-40 секунд.

Примеры кода

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

Пример получения документа с идентификатором 61.

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":61}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.documentgenerator.document.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":61,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.documentgenerator.document.get

try
        {
        	const response = await $b24.callMethod(
        		'crm.documentgenerator.document.get',
        		{
        			id: 61,
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.documentgenerator.document.get',
                    [
                        'id' => 61,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting document: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.documentgenerator.document.get',
            {
                id: 61,
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.documentgenerator.document.get',
            [
                'id' => 61,
            ]
        );
        
        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-001",
                    "id": "61",
                    "createTime": "2026-03-20T13:51:45+03:00",
                    "createdBy": "577",
                    "updateTime": "2026-03-20T13:51:45+03:00",
                    "updatedBy": null,
                    "stampsEnabled": true,
                    "isTransformationError": false,
                    "values": {
                        "productsTableVariant": "",
                        "_creationMethod": "rest",
                        "stampsEnabled": true
                    },
                    "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": 5609,
                    "entityId": "101",
                    "entityTypeId": "2",
                    "downloadUrlMachine": "https://bitrix.bitrix24.ru/rest/crm.documentgenerator.document.download.json?...",
                    "imageUrlMachine": "https://bitrix.bitrix24.ru/rest/crm.documentgenerator.document.getImage.json?...",
                    "pdfUrlMachine": "https://bitrix.bitrix24.ru/rest/crm.documentgenerator.document.getPdf.json?..."
                }
            },
            "time": {
                "start": 1774006578,
                "finish": 1774006578.790473,
                "duration": 0.7904729843139648,
                "processing": 0,
                "date_start": "2026-03-20T14:36:18+03:00",
                "date_finish": "2026-03-20T14:36:18+03:00",
                "operating_reset_at": 1774007178,
                "operating": 0.23765993118286133
            }
        }

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

Название `тип`	Описание
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`	Ссылка на скачивание документа для машинного доступа
imageUrl `string`	Ссылка на изображение документа. Может быть пустой строкой сразу после создания или обновления
imageUrlMachine `string`	Ссылка на изображение документа для машинного доступа
pdfUrl `string`	Ссылка на PDF-документ. Может быть пустой строкой сразу после создания или обновления
pdfUrlMachine `string`	Ссылка на PDF-документ для машинного доступа
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`	Значения полей документа

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

HTTP-статус: 400

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

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

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

Код	Описание	Значение
`DOCGEN_ACCESS_ERROR`	Access denied	Нет доступа к документу
`0`	Документ не найден	Документ с указанным `id` не найден или недоступен
`Пустое значение`	Document not found	Документ не относится к модулю `crm`
`100`	Bitrix\DocumentGenerator\Document constructor must be is public	Не передан обязательный параметр `id`
`Пустое значение`	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.get

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

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

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

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

Тип resultТип result

Тип documentТип document

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

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

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

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