Получить поле документа складского учета catalog.document.field.get

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

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

Scope: catalog

Кто может выполнять метод: любой пользователь

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод catalog.document.field.get возвращает описание поля документа складского учета по имени.

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

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

Название
тип

Описание

name*
string

Имя поля, описание которого нужно получить.

Доступные поля:

  • id — идентификатор документа
  • docType — тип документа
  • siteId — идентификатор сайта
  • responsibleId — идентификатор ответственного
  • dateModify — дата изменения
  • dateCreate — дата создания
  • createdBy — кто создал
  • modifiedBy — кто изменил
  • currency — валюта
  • status — статус проведения
  • dateStatus — дата изменения статуса
  • dateDocument — дата документа
  • statusBy — кто изменил статус
  • total — сумма
  • commentary — комментарий
  • title — название
  • docNumber — номер входящего документа
  • contractorId — идентификатор поставщика

select
array

Массив свойств описания, которые нужно вернуть в ответе.

Доступные поля:

  • name — имя поля
  • type — тип данных
  • title — заголовок
  • description — описание
  • validationRules — правила валидации
  • requiredGroups — группы обязательности
  • filterable — признак доступности в фильтре
  • sortable — признак доступности в сортировке
  • editable — признак редактируемости
  • editableGroups — группы операций, в которых поле редактируется
  • multiple — признак множественного значения
  • elementType — тип элемента для составных полей

По умолчанию: все свойства описания

Примеры кода

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

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/catalog.document.field.get

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"docType","select":["name","type","title","requiredGroups","editableGroups"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.document.field.get

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"docType","select":["name","type","title","requiredGroups","editableGroups"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.document.field.get

import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type DocumentFieldGetResult = {
  item: {
    name: string
    type: string
    title: string
    requiredGroups: string[] | null
    editableGroups: string[] | null
  }
}

try {
  const response = await $b24.actions.v3.call.make<DocumentFieldGetResult>({
    method: 'catalog.document.field.get',
    params: {
      name: 'docType',
      select: ['name', 'type', 'title', 'requiredGroups', 'editableGroups'],
    },
    requestId: Text.getUuidRfc4122()
  })

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Field:', result.item.name, result.item.type)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function callDocumentFieldGet() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'catalog.document.field.get',
        params: {
          name: 'docType',
          select: ['name', 'type', 'title', 'requiredGroups', 'editableGroups'],
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Field:', result.item.name, result.item.type)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', callDocumentFieldGet)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.catalog.document.field.get(
        name="docType",
        select=["name", "type", "title", "requiredGroups", "editableGroups"],
    ).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}")

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'catalog.document.field.get',
            [
                'name' => 'docType',
                'select' => ['name', 'type', 'title', 'requiredGroups', 'editableGroups'],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    if ($result->error()) {
        error_log($result->error());
    } else {
        echo 'Success: ' . print_r($result->data(), true);
    }

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error: ' . $e->getMessage();
}

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

BX24.callMethod(
    'catalog.document.field.get',
    {
        name: 'docType',
        select: ['name', 'type', 'title', 'requiredGroups', 'editableGroups'],
    },
    result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

require_once('crest.php');

$result = CRest::call(
    'catalog.document.field.get',
    [
        'name' => 'docType',
        'select' => ['name', 'type', 'title', 'requiredGroups', 'editableGroups'],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.document.field.get", b24.Params{
	"name":   "docType",
	"select": []string{"name", "type", "title", "requiredGroups", "editableGroups"},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("catalog.document.field.get: %w", err)
}

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

var item struct {
	Name           string   `json:"name"`
	Type           string   `json:"type"`
	RequiredGroups []string `json:"requiredGroups"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Name, item.Type)

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

HTTP-статус: 200

{
    "result": {
        "item": {
            "name": "docType",
            "type": "string",
            "title": "docType",
            "requiredGroups": [
                "add"
            ],
            "editableGroups": [
                "add"
            ]
        }
    },
    "time": {
        "start": 1792665253,
        "finish": 1792665253.905826,
        "duration": 0.9058260917663574,
        "processing": 0,
        "date_start": "2026-10-22T13:34:13+03:00",
        "date_finish": "2026-10-22T13:34:13+03:00",
        "operating_reset_at": 1792665840,
        "operating": 0
    }
}

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

Название
тип

Описание

result
object

Объект с данными ответа

result.item
object

Описание поля. Состав свойств зависит от select. Описание свойств

time
time

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

Объект item

Название
тип

Описание

name
string

Имя поля документа

type
string

Тип в метаданных: int, string, float, object. Для полей даты возвращается object, хотя значения дат в ответах методов передаются строками ISO 8601

title
string

Заголовок поля. Совпадает с name

description
string или null

Описание поля. Для полей документа — null

validationRules
array

Правила валидации. Для полей документа — пустой массив

requiredGroups
array или null

Операции, в которых поле обязательно. Для docType, currency и responsibleId — ["add"]

filterable
boolean

true — поле доступно в фильтре, false — недоступно

sortable
boolean

true — поле доступно в сортировке, false — недоступно

editable
boolean

true — поле можно передавать в операциях из editableGroups

editableGroups
array или null

Операции, в которых поле можно задавать. Для docType и currency — ["add"]

multiple
boolean

Признак множественного значения. Для полей документа — false

elementType
string или null

Тип элемента составного поля. Для полей документа — null

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION",
        "message": "Поле `foo` не найдено"
    }
}

Название
тип

Описание

error.code
string

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

error.message
string

Текстовое описание ошибки

error.validation
array

Массив c деталями ошибки. Присутствует только в ошибках валидации данных BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Название поля, в котором возникла ошибка валидации

error.validation[].message
string

Описание ошибки, связанной с указанным полем

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

Ошибка отсутствия поля

HTTP-статус: 404

Код ошибки: BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION

Поле

Описание ошибки

Как исправить

name

Поле #FIELD# не найдено

Укажите имя поля из описания параметра name

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле

Описание ошибки

Как исправить

name

Обязательное поле name не указано

Передайте параметр name

Ошибка неизвестного поля

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле

Описание ошибки

Как исправить

select

Неизвестное поле #FIELD# для сущности DtoFieldDto

Укажите в select только свойства из описания параметра select

Ошибка формата select

Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION

Поле

Описание ошибки

Как исправить

select

Не удается распознать выражение select #SELECT#

Передайте select массивом строк, например ["name","type"]

Ошибка доступа

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Поле

Описание ошибки

Как исправить

-

Доступ запрещен

Проверьте права пользователя и scope catalog

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

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

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

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

Предыдущая
Получить список полей документа складского учета v 3.0
Следующая
Получить типы документов складского учета