Получить поля шаблона документа crm.documentgenerator.template.getfields

Scope: crm

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

Метод crm.documentgenerator.template.getfields возвращает карточку полей шаблона: какие поля доступны, их текущие значения, значения по умолчанию и служебные признаки.

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

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

Название `тип`	Описание
id^* `integer`	Идентификатор шаблона
entityTypeId^* `integer`	Идентификатор типа CRM-элемента. Нужен для выбора провайдера данных
entityId `integer`	Идентификатор CRM-элемента, данные которого будут использованы для вычисления значений полей
values `object`	Объект формата: `{ field_1: value_1, field_2: value_2, ..., field_n: value_n, }` где: `field_n` — название поля `value_n` — значение поля `values` — это временные подстановки поверх данных CRM. Метод берет данные по `entityTypeId` и `entityId`, затем накладывает значения из `values` и пересчитывает поля шаблона. Это позволяет проверить результат без изменения данных в CRM. Например, если передать `values.DocumentNumber = "2026-001"`, в ответе поле `DocumentNumber` вернется уже с этим значением. Если `values` не передавать, метод вернет карточку полей на основе исходных данных CRM и логики шаблона

Параметр values

Состав ключей values определяется шаблоном, провайдером данных и контекстом (entityTypeId, entityId), поэтому в разных сценариях может отличаться.

Название `тип`	Описание
MyCompanyRequisiteRqCompanyName `string`	Сокращенное наименование организации
MyCompanyRequisiteRegisteredAddressText `string`	Полный адрес
MyCompanyPhone `string`	Телефон
MyCompanyEmail `string`	E-mail
MyCompanyWeb `string`	Сайт
MyCompanyUfLogo `string` \| `null`	Логотип
RequisiteRqCompanyName `string`	Сокращенное наименование организации
RequisiteRegisteredAddressText `string`	Полный адрес
ClientPhone `string`	Телефон
ClientEmail `string`	Email
ClientWeb `string`	Сайт
DocumentNumber `string`	Номер
DocumentCreateTime `string`	Дата генерации
ProductsIndex `string`	Текущий номер
ProductsProductName `array` \| `string`	Название
ProductsProductQuantity `array` \| `string`	Количество
ProductsProductMeasureName `array` \| `string`	Единицы измерения
ProductsProductPriceRaw `array` \| `string`	Исходная цена
ProductsProductPriceRawSum `array` \| `string`	Сумма исходной цены
TotalRaw `string`	Сумма исходных цен
TaxesTaxTitle `array` \| `string`	Заголовок
TaxesTaxRate `array` \| `string`	Ставка
TaxesTaxValue `array` \| `string`	Сумма
TotalSum `string`	Общая сумма
MyCompanyAssignedName `string`	Имя
MyCompanyAssignedLastName `string`	Фамилия
MyCompanyAssignedPersonalPhone `string`	Телефон
MyCompanyAssignedEmail `string`	E-Mail
DocumentTitle `string`	Название документа
MY_COMPANY `array`	Моя компания

Примеры кода

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

Пример получения полей шаблона документа, где:

идентификатор шаблона — 1
идентификатор типа CRM-элемента — 2 (сделка)
идентификатор CRM-элемента — 123
значение поля DocumentNumber — 2026-001

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":1,"entityTypeId":2,"entityId":123,"values":{"DocumentNumber":"2026-001"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.documentgenerator.template.getfields

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":1,"entityTypeId":2,"entityId":123,"values":{"DocumentNumber":"2026-001"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.documentgenerator.template.getfields

try
        {
        	const response = await $b24.callMethod(
        		'crm.documentgenerator.template.getfields',
        		{
        			id: 1,
        			entityTypeId: 2,
        			entityId: 123,
        			values: {
        				DocumentNumber: '2026-001',
        			},
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.documentgenerator.template.getfields',
                    [
                        'id' => 1,
                        'entityTypeId' => 2,
                        'entityId' => 123,
                        'values' => [
                            'DocumentNumber' => '2026-001',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting template fields: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.documentgenerator.template.getfields',
            {
                id: 1,
                entityTypeId: 2,
                entityId: 123,
                values: {
                    DocumentNumber: '2026-001',
                },
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.documentgenerator.template.getfields',
            [
                'id' => 1,
                'entityTypeId' => 2,
                'entityId' => 123,
                'values' => [
                    'DocumentNumber' => '2026-001',
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
                "templateFields": {
                    "DocumentNumber": {
                        "title": "Номер",
                        "value": "2026-001",
                        "required": "Y",
                        "group": [
                            "Документ"
                        ],
                        "chain": "this.DOCUMENT.DOCUMENT_NUMBER",
                        "default": "2026-001"
                    },
                    "MyCompanyUfLogo": {
                        "title": "Логотип",
                        "value": null,
                        "type": "IMAGE",
                        "group": [
                            "Документ",
                            "Моя компания"
                        ],
                        "chain": "this.SOURCE.MY_COMPANY.UF_LOGO",
                        "default": null
                    },
                    "MY_COMPANY": {
                        "title": "Моя компания",
                        "value": [
                            {
                                "value": "340",
                                "title": "Колесо Фортуны",
                                "selected": true
                            },
                            {
                                "value": "358",
                                "title": "Битрикс-Разработка",
                                "selected": false
                            }
                        ],
                        "group": [
                            "Документ",
                            "Моя компания"
                        ]
                    }
                }
            },
            "time": {
                "start": 1773821944,
                "finish": 1773821944.196063,
                "duration": 0.19606304168701172,
                "processing": 0,
                "date_start": "2026-03-18T11:19:04+03:00",
                "date_finish": "2026-03-18T11:19:04+03:00",
                "operating_reset_at": 1773822544,
                "operating": 0
            }
        }

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

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

Тип result

Название `тип`	Описание
templateFields `object`	Объект полей шаблона, где ключом является код поля, а значением — структура `templateField`

Тип templateField

Название `тип`	Описание
title `string`	Название поля
value `string` \| `array`	Текущее значение поля
default `string`	Значение поля по умолчанию
required `char`	Признак обязательности поля: `Y` или `N`
type `string`	Тип поля, например `IMAGE`
group `array`	Группы, к которым относится поле
chain `string`	Путь поля в провайдере данных, например `this.SOURCE.MY_COMPANY.UF_LOGO`

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

HTTP-статус: 400

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

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

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

Код	Описание	Значение
`DOCGEN_ACCESS_ERROR`	Access denied	Нет доступа к шаблону или недостаточно прав для работы с шаблонами генератора документов
`0`	Шаблон не найден	Шаблон с указанным `id` не найден или недоступен
`100`	Bitrix\DocumentGenerator\Template constructor must be is public	Не передан обязательный параметр
`Пустое значение`	Cannot get fields from deleted template	Нельзя получить поля удаленного шаблона
`Пустое значение`	You do not have permissions to modify templates	Недостаточно прав для изменения шаблонов генератора документов
`Пустое значение`	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.template.getfields

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

Параметр valuesПараметр values

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

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

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

Тип resultТип result

Тип templateFieldТип templateField

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

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

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

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