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

Scope: crm

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

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

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

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

Название
тип

Описание

id*
integer

Идентификатор документа

values
object

Объект формата:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n
        }

где:

  • field_n — код поля документа
  • value_n — значение поля

values — это временные подстановки поверх текущих значений документа. Метод берет данные документа, накладывает values и пересчитывает поля.

Это позволяет проверить результат без изменения самого документа. Например, если передать values.DocumentNumber = "2026-001", в ответе поле DocumentNumber вернется со значением 2026-001. Если не передавать values, для того же поля вернется текущее значение документа, например 1.

Если values не передавать, метод вернет карточку полей на основе текущих данных документа и логики шаблона

Параметр values

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

Название
тип

Описание

DocumentNumber
string

Номер документа

DocumentCreateTime
string

Дата генерации

DocumentTitle
string

Название документа

ClientPhone
string

Телефон клиента

ClientEmail
string

Email клиента

ProductsProductName
array | string

Название товара

ProductsProductQuantity
array | string

Количество

TotalSum
string

Общая сумма

Примеры кода

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

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

  • идентификатор документа — 101
  • значение поля DocumentNumber — 2026-001
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":101,"values":{"DocumentNumber":"2026-001"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.documentgenerator.document.getfields
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":101,"values":{"DocumentNumber":"2026-001"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.documentgenerator.document.getfields
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.documentgenerator.document.getfields',
        		{
        			id: 101,
        			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.document.getfields',
                    [
                        'id' => 101,
                        '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 document fields: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.documentgenerator.document.getfields',
            {
                id: 101,
                values: {
                    DocumentNumber: '2026-001',
                },
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.documentgenerator.document.getfields',
            [
                'id' => 101,
                'values' => [
                    'DocumentNumber' => '2026-001',
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
                "documentFields": {
                    "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": 1773909500,
                "finish": 1773909500.192341,
                "duration": 0.19234108924865723,
                "processing": 0,
                "date_start": "2026-03-19T11:38:20+03:00",
                "date_finish": "2026-03-19T11:38:20+03:00",
                "operating_reset_at": 1773910100,
                "operating": 0
            }
        }

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

Название
тип

Описание

result
object

Корневой элемент ответа. Содержит объект result

time
time

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

Тип result

Название
тип

Описание

documentFields
object

Объект полей документа, где ключом является код поля, а значением — структура documentField

Тип documentField

Название
тип

Описание

title
string

Название поля

value
string | array | null

Текущее значение поля

default
string | null

Значение поля по умолчанию

required
char

Признак обязательности поля: Y или N

type
string

Тип поля, например IMAGE

group
array

Группы, к которым относится поле

chain
string | array

Путь поля в провайдере данных, например this.SOURCE.MY_COMPANY.UF_LOGO

format
object

Параметры форматирования поля, например {"currencyId":"RUB","withZeros":true}

options
object

Дополнительные параметры поля, например {"isArray":true}

hideRow
char

Служебный признак скрытия строки: Y или N

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

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

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

Код

Описание

Значение

100

Bitrix\DocumentGenerator\Document constructor must be is public

Не передан обязательный параметр id

DOCGEN_ACCESS_ERROR

Access denied

Нет доступа к документу или недостаточно прав для работы с документами генератора

0

Документ не найден

Документ с указанным id не найден или недоступен

Пустое значение

You do not have permissions to modify 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-объекту
Следующая
Обзор событий