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

Scope: catalog

Кто может выполнять метод: пользователь с правом «Просмотр каталога товаров»

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

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

Без параметров.

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.document.getFields
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/catalog.document.getFields
        
try
        {
        	const response = await $b24.callMethod(
        		'catalog.document.getFields',
        		{}
        	);
        
        	const result = response.getData().result;
        	console.log(result);
        }
        catch (error)
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.document.getFields',
                    []
                );
        
            $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 getting document fields: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'catalog.document.getFields',
            {},
            function(result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'catalog.document.getFields',
            []
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-код: 200

{
            "result": {
                "document": {
                    "commentary": {
                        "isImmutable": false,
                        "isReadOnly": false,
                        "isRequired": false,
                        "type": "char"
                    },
                    "createdBy": {
                        "isImmutable": true,
                        "isReadOnly": false,
                        "isRequired": false,
                        "type": "integer"
                    },
                    "currency": {
                        "isImmutable": true,
                        "isReadOnly": false,
                        "isRequired": true,
                        "type": "char"
                    },
                    "dateCreate": {
                        "isImmutable": true,
                        "isReadOnly": false,
                        "isRequired": false,
                        "type": "datetime"
                    },
                    "dateDocument": {
                        "isImmutable": false,
                        "isReadOnly": false,
                        "isRequired": false,
                        "type": "datetime"
                    },
                    "dateModify": {
                        "isImmutable": false,
                        "isReadOnly": false,
                        "isRequired": false,
                        "type": "datetime"
                    },
                    "dateStatus": {
                        "isImmutable": false,
                        "isReadOnly": true,
                        "isRequired": false,
                        "type": "datetime"
                    },
                    "docNumber": {
                        "isImmutable": false,
                        "isReadOnly": false,
                        "isRequired": false,
                        "type": "string"
                    },
                    "docType": {
                        "isImmutable": true,
                        "isReadOnly": false,
                        "isRequired": true,
                        "type": "char"
                    },
                    "id": {
                        "isImmutable": false,
                        "isReadOnly": true,
                        "isRequired": false,
                        "type": "integer"
                    },
                    "modifiedBy": {
                        "isImmutable": false,
                        "isReadOnly": false,
                        "isRequired": false,
                        "type": "integer"
                    },
                    "responsibleId": {
                        "isImmutable": false,
                        "isReadOnly": false,
                        "isRequired": true,
                        "type": "integer"
                    },
                    "siteId": {
                        "isImmutable": false,
                        "isReadOnly": false,
                        "isRequired": false,
                        "type": "char"
                    },
                    "status": {
                        "isImmutable": false,
                        "isReadOnly": true,
                        "isRequired": false,
                        "type": "char"
                    },
                    "statusBy": {
                        "isImmutable": false,
                        "isReadOnly": false,
                        "isRequired": false,
                        "type": "integer"
                    },
                    "title": {
                        "isImmutable": false,
                        "isReadOnly": false,
                        "isRequired": false,
                        "type": "string"
                    },
                    "total": {
                        "isImmutable": false,
                        "isReadOnly": false,
                        "isRequired": false,
                        "type": "double"
                    }
                }
            },
            "time": {
                "start": 1761727898,
                "finish": 1761727898.554004,
                "duration": 0.5540039539337158,
                "processing": 0,
                "date_start": "2025-10-29T11:51:38+03:00",
                "date_finish": "2025-10-29T11:51:38+03:00",
                "operating_reset_at": 1761728498,
                "operating": 0
            }
        }

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

Название
тип

Описание

result
object

Корневой элемент ответа

document
object

Объект с описанием полей документа складского учета
Объект в формате {"field_1": "value_1", ... "field_N": "value_N"}. Где field — идентификатор поля объекта catalog_document, а value — объект типа rest_field_description.

time
time

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

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

Название
тип

Описание

error
string

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

error_description
error_description

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

HTTP-код: 400

{
            "error": "0",
            "error_description": "Недостаточно прав для сохранения документа"
        }

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

Код

Описание

Значение

0

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

У пользователя нет права на просмотр

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

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

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

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

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