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

Scope: catalog

Кто может выполнять метод: пользователь с правами:
— «Просмотр» на тип документа «Приход»,
— «Просмотр раздела Складской учет»
— «Просмотр каталога товаров»

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

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

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

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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.documentcontractor.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.documentcontractor.getFields

try
        {
            const response = await $b24.callMethod(
                'catalog.documentcontractor.getFields',
                {}
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.documentcontractor.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 contractor binding fields: ' . $e->getMessage();
        }

BX24.callMethod(
            'catalog.documentcontractor.getFields',
            {},
            function(result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'catalog.documentcontractor.getFields',
            []
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-код: 200

{
            "result": {
                "documentContractor": {
                    "documentId": {
                        "isImmutable": false,
                        "isReadOnly": false,
                        "isRequired": true,
                        "type": "integer"
                    },
                    "entityId": {
                        "isImmutable": false,
                        "isReadOnly": false,
                        "isRequired": true,
                        "type": "integer"
                    },
                    "entityTypeId": {
                        "isImmutable": false,
                        "isReadOnly": false,
                        "isRequired": true,
                        "type": "integer"
                    },
                    "id": {
                        "isImmutable": false,
                        "isReadOnly": true,
                        "isRequired": false,
                        "type": "integer"
                    }
                }
            },
            "time": {
                "start": 1766410081,
                "finish": 1766410081.636695,
                "duration": 0.6366949081420898,
                "processing": 0,
                "date_start": "2025-12-22T16:28:01+03:00",
                "date_finish": "2025-12-22T16:28:01+03:00",
                "operating_reset_at": 1766410681,
                "operating": 0
            }
        }

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

Название `тип`	Описание
result `object`	Корневой элемент ответа
documentContractor `object`	Объект с описанием полей привязки поставщика к документу складского учета. Объект в формате `{"field_1": "value_1", ... "field_N": "value_N"}`. Где `field` — идентификатор поля объекта `catalog_documentContractor`, а `value` — объект типа `rest_field_description`
time `time`	Информация о времени выполнения запроса

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

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

HTTP-код: 400

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

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

Код	Описание	Значение
`0`	Access denied	Недостаточно прав для просмотра документа или привязок
`0`	Contractors should be provided by CRM	Модуль CRM не активен как поставщик контрагентов

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

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

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

Удалить привязку к документу

Получить список привязок к документам

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

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

Примеры кодаПримеры кода

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

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

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

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

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

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