Получить поля шаблона документа crm.documentgenerator.template.getfields
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: пользователь с правом "изменения" шаблонов генератора документов
Метод crm.documentgenerator.template.getfields возвращает карточку полей шаблона: какие поля доступны, их текущие значения, значения по умолчанию и служебные признаки.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Идентификатор шаблона |
|
entityTypeId* |
Идентификатор типа CRM-элемента. Нужен для выбора провайдера данных |
|
entityId |
Идентификатор CRM-элемента, данные которого будут использованы для вычисления значений полей |
|
values |
Объект формата:
где:
Это позволяет проверить результат без изменения данных в CRM. Например, если передать Если |
Параметр values
Состав ключей values определяется шаблоном, провайдером данных и контекстом (entityTypeId, entityId), поэтому в разных сценариях может отличаться.
|
Название |
Описание |
|
MyCompanyRequisiteRqCompanyName |
Сокращенное наименование организации |
|
MyCompanyRequisiteRegisteredAddressText |
Полный адрес |
|
MyCompanyPhone |
Телефон |
|
MyCompanyEmail |
|
|
MyCompanyWeb |
Сайт |
|
Логотип |
|
|
RequisiteRqCompanyName |
Сокращенное наименование организации |
|
RequisiteRegisteredAddressText |
Полный адрес |
|
ClientPhone |
Телефон |
|
ClientEmail |
|
|
ClientWeb |
Сайт |
|
DocumentNumber |
Номер |
|
DocumentCreateTime |
Дата генерации |
|
ProductsIndex |
Текущий номер |
|
Название |
|
|
Количество |
|
|
Единицы измерения |
|
|
Исходная цена |
|
|
Сумма исходной цены |
|
|
TotalRaw |
Сумма исходных цен |
|
Заголовок |
|
|
Ставка |
|
|
Сумма |
|
|
TotalSum |
Общая сумма |
|
MyCompanyAssignedName |
Имя |
|
MyCompanyAssignedLastName |
Фамилия |
|
MyCompanyAssignedPersonalPhone |
Телефон |
|
MyCompanyAssignedEmail |
|
|
DocumentTitle |
Название документа |
|
MY_COMPANY |
Моя компания |
Примеры кода
Как использовать примеры в документации
Пример получения полей шаблона документа, где:
- идентификатор шаблона —
1 - идентификатор типа CRM-элемента —
2(сделка) - идентификатор CRM-элемента —
123 - значение поля
DocumentNumber—2026-001
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
// 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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type GetFieldsResult = {
templateFields: Record<string, TemplateField>
}
type TemplateField = {
title: string
value: string | string[] | null
default?: string | null
required?: string
type?: string
group: string[]
chain?: string
}
try {
const response = await $b24.actions.v2.call.make<GetFieldsResult>({
method: 'crm.documentgenerator.template.getfields',
params: {
id: 1,
entityTypeId: 2,
entityId: 123,
values: {
DocumentNumber: '2026-001',
},
},
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('Template fields:', Object.keys(result.templateFields))
}
} 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 getTemplateFields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.documentgenerator.template.getfields',
params: {
id: 1,
entityTypeId: 2,
entityId: 123,
values: {
DocumentNumber: '2026-001',
},
},
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('Template fields:', Object.keys(result.templateFields))
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getTemplateFields)
</script>
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();
}
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.documentgenerator.template.getfields(
bitrix_id=1,
entity_type_id=2,
entity_id=123,
values={
"DocumentNumber": "2026-001",
},
).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.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 |
Корневой элемент ответа. Содержит объект |
|
time |
Информация о времени выполнения запроса |
Тип result
|
Название |
Описание |
|
templateFields |
Объект полей шаблона, где ключом является код поля, а значением — структура |
Тип templateField
|
Название |
Описание |
|
title |
Название поля |
|
Текущее значение поля |
|
|
default |
Значение поля по умолчанию |
|
required |
Признак обязательности поля: |
|
type |
Тип поля, например |
|
group |
Группы, к которым относится поле |
|
chain |
Путь поля в провайдере данных, например |
Обработка ошибок
HTTP-статус: 400
{
"error": "DOCGEN_ACCESS_ERROR",
"error_description": "Access denied"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Access denied |
Нет доступа к шаблону или недостаточно прав для работы с шаблонами генератора документов |
|
|
Шаблон не найден |
Шаблон с указанным |
|
|
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 |
Модуль |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить новый шаблон crm.documentgenerator.template.add
- Изменить существующий шаблон документа crm.documentgenerator.template.update
- Получить информацию о шаблоне документа по Id crm.documentgenerator.template.get
- Получить список шаблонов документов crm.documentgenerator.template.list
- Удалить шаблон документа crm.documentgenerator.template.delete
- Получить поля документа crm.documentgenerator.document.getfields
- Как добавить шаблон и создать документ на его основе