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

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

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 -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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

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}")
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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.documentgenerator.template.getfields", b24.Params{
	"id":           1,
	"entityTypeId": 2,
	"entityId":     123,
	"values": b24.Params{
		"DocumentNumber": "2026-001",
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("crm.documentgenerator.template.getfields: %w", err)
}

// Метод заворачивает ответ в объект с ключом "templateFields".
raw, ok := b24.Unwrap(res.Result, "templateFields")
if !ok {
	return fmt.Errorf("в ответе нет ключа templateFields")
}

fmt.Printf("%s\n", raw)

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

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
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

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

Код

Описание

Значение

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-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

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

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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