Добавить поставщика к документу складского учета catalog.documentcontractor.add

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: catalog

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

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

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

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

Название `тип`	Описание
fields* `object`	Поля привязки (подробное описание)

Параметр fields

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

Название `тип`	Описание
documentId* `catalog_document.id`	Идентификатор документа складского учета типа «Приход» `A`. Получить можно методом catalog.document.list
entityTypeId* `integer`	Тип объекта CRM: `3` — контакт `4` — компания
entityId* `integer`	Идентификатор элемента CRM, контакта или компании, из категории «Поставщик». Чтобы получить идентификаторы поставщиков: Получите идентификатор категории с кодом `CATALOG_CONTRACTOR_CONTACT` для контактов или `CATALOG_CONTRACTOR_COMPANY` для компаний методом crm.category.list. Используйте полученный `categoryId` в фильтре запроса crm.item.list

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"documentId":42,"entityTypeId":3,"entityId":101}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.documentcontractor.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"documentId":42,"entityTypeId":3,"entityId":101},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/catalog.documentcontractor.add

try
        {
            const response = await $b24.callMethod(
                'catalog.documentcontractor.add',
                {
                    fields: {
                        documentId: 42,
                        entityTypeId: 3,
                        entityId: 101
                    }
                }
            );
        
            const result = response.getData().result;
            console.log('Created binding:', result);
        }
        catch (error)
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.documentcontractor.add',
                    [
                        'fields' => [
                            'documentId' => 42,
                            'entityTypeId' => 3,
                            'entityId' => 101
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result) {
                echo 'Success: ' . print_r($result, true);
            }
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding contractor binding: ' . $e->getMessage();
        }

BX24.callMethod(
            'catalog.documentcontractor.add',
            {
                fields: {
                    documentId: 42,
                    entityTypeId: 3,
                    entityId: 101
                }
            },
            function(result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'catalog.documentcontractor.add',
            [
                'fields' => [
                    'documentId' => 42,
                    'entityTypeId' => 3,
                    'entityId' => 101
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-код: 200

{
            "result": {
                "documentContractor": {
                    "documentId": 73,
                    "entityId": 2185,
                    "entityTypeId": 3,
                    "id": 15
                }
            },
            "time": {
                "start": 1766469835,
                "finish": 1766469835.824666,
                "duration": 0.8246660232543945,
                "processing": 0,
                "date_start": "2025-12-23T09:03:55+03:00",
                "date_finish": "2025-12-23T09:03:55+03:00",
                "operating_reset_at": 1766470435,
                "operating": 0
            }
        }

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

Название `тип`	Описание
result `object`	Корневой элемент ответа
documentContractor `catalog_documentContractor`	Объект с данными созданной привязки поставщика к документу складского учета
time `time`	Информация о времени выполнения запроса

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

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

HTTP-код: 400

{
            "error": "0",
            "error_description": "Store document was not found"
        }

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

Код	Описание	Значение
`0`	Store document was not found	Указан несуществующий или недоступный идентификатор документа
`0`	Type of store document is wrong	Документ не является типом «Приход» `A`
`0`	Unable to edit conducted document	Документ уже проведен и не может быть изменен
`0`	Wrong entity type id	Передан недопустимый `entityTypeId`, должен быть 3 или 4
`0`	Wrong entity id	Указан недопустимый или несуществующий `entityId`
`0`	This contractor has been already bound to this document	Такая привязка уже существует
`0`	This document already has a Company contractor	К документу уже привязана компания. Повторная привязка компаний запрещена
`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	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут
`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.add

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

Параметр fieldsПараметр fields

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

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

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

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

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

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

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