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

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

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

Scope: catalog

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

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

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

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

Название
тип

Описание

fields*
object

Поля привязки (подробное описание)

Параметр fields

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

Название
тип

Описание

documentId*
catalog_document.id

Идентификатор документа складского учета типа «Приход» A.
Получить можно методом catalog.document.list

entityTypeId*
integer

Тип объекта CRM:
3 — контакт
4 — компания

entityId*
integer

Идентификатор элемента CRM, контакта или компании, из категории «Поставщик».

Чтобы получить идентификаторы поставщиков:

  1. Получите идентификатор категории с кодом CATALOG_CONTRACTOR_CONTACT для контактов или CATALOG_CONTRACTOR_COMPANY для компаний методом crm.category.list.
  2. Используйте полученный categoryId в фильтре запроса crm.item.list

Примеры кода

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

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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type DocumentContractorAddResult = {
  documentContractor: {
    documentId: number
    entityId: number
    entityTypeId: number
    id: number
  }
}

try {
  const response = await $b24.actions.v2.call.make<DocumentContractorAddResult>({
    method: 'catalog.documentcontractor.add',
    params: {
      fields: {
        documentId: 42,
        entityTypeId: 3,
        entityId: 101,
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info(result.documentContractor.id, result.documentContractor)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function addDocumentContractor() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'catalog.documentcontractor.add',
        params: {
          fields: {
            documentId: 42,
            entityTypeId: 3,
            entityId: 101,
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info(result.documentContractor.id, result.documentContractor)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', addDocumentContractor)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.catalog.documentcontractor.add(
        fields={
            "documentId": 42,
            "entityTypeId": 3,
            "entityId": 101,
        },
    ).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}")
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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.documentcontractor.add", b24.Params{
	"fields": b24.Params{
		"documentId":   42,
		"entityTypeId": 3,
		"entityId":     101,
	},
})
if err != nil {
	return fmt.Errorf("catalog.documentcontractor.add: %w", err)
}

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

var item struct {
	DocumentID   b24.ID `json:"documentId"`
	EntityID     b24.ID `json:"entityId"`
	EntityTypeID b24.ID `json:"entityTypeId"`
	ID           b24.ID `json:"id"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.DocumentID, item.EntityID)

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

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
string

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

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-статус: 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

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

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