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

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

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

Scope: catalog

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

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

Метод catalog.document.contractor.add привязывает контакт или компанию CRM как поставщика к документу прихода и возвращает привязку.

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

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

Название `тип`	Описание
fields* `object`	Объект с полями новой привязки. Описание полей

Параметр fields

Название `тип`	Описание
documentId* `integer`	Идентификатор документа прихода с типом `A`. Документ не должен быть проведен. Идентификатор можно получить методом catalog.document.list или из ответа catalog.document.add
entityTypeId* `integer`	Тип объекта CRM. Возможные значения: `3` — контакт `4` — компания
entityId* `integer`	Идентификатор контакта или компании. Идентификатор можно получить методами crm.contact.list и crm.company.list. К документу можно привязать несколько контактов и только одну компанию. Метод не проверяет, что объект CRM существует

Поле id заполняется автоматически. Если передать его в fields, метод вернет ошибку.

Примеры кода

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

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

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

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

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

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

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

declare const $b24: B24Frame

type DocumentContractorAddResult = {
  item: {
    id: number
    documentId: number
    entityTypeId: number
    entityId: number
  }
}

try {
  const response = await $b24.actions.v3.call.make<DocumentContractorAddResult>({
    method: 'catalog.document.contractor.add',
    params: {
      fields: {
        documentId: 325,
        entityTypeId: 3,
        entityId: 1,
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Contractor bound:', result.item.id)
  }
} 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 documentContractorAdd() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'catalog.document.contractor.add',
        params: {
          fields: {
            documentId: 325,
            entityTypeId: 3,
            entityId: 1,
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

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

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

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

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.catalog.document.contractor.add(
        fields={
            "documentId": 325,
            "entityTypeId": 3,
            "entityId": 1,
        },
    ).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.contractor.add',
            [
                'fields' => [
                    'documentId' => 325,
                    'entityTypeId' => 3,
                    'entityId' => 1,
                ],
            ]
        );

    $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.contractor.add',
    {
        fields: {
            documentId: 325,
            entityTypeId: 3,
            entityId: 1,
        },
    },
    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.contractor.add',
    [
        'fields' => [
            'documentId' => 325,
            'entityTypeId' => 3,
            'entityId' => 1,
        ],
    ]
);

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

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.document.contractor.add", b24.Params{
	"fields": b24.Params{
		"documentId":   325,
		"entityTypeId": 3,
		"entityId":     1,
	},
})
if err != nil {
	return fmt.Errorf("catalog.document.contractor.add: %w", err)
}

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

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

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

HTTP-статус: 200

{
    "result": {
        "item": {
            "id": 29,
            "documentId": 325,
            "entityTypeId": 3,
            "entityId": 1
        }
    },
    "time": {
        "start": 1792665375,
        "finish": 1792665375.827902,
        "duration": 0.82790207862854,
        "processing": 0,
        "date_start": "2026-10-22T13:36:15+03:00",
        "date_finish": "2026-10-22T13:36:15+03:00",
        "operating_reset_at": 1792665960,
        "operating": 0
    }
}

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

Название `тип`	Описание
result `object`	Объект с данными ответа
result.item `object`	Поля созданной привязки. Описание полей
time `time`	Информация о времени выполнения запроса

Объект item

Название `тип`	Описание
id `integer`	Идентификатор привязки
documentId `integer`	Идентификатор документа складского учета
entityTypeId `integer`	Тип объекта CRM: `3` — контакт, `4` — компания
entityId `integer`	Идентификатор контакта или компании

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта запроса",
        "validation": [
            {
                "message": "This document already has a Company contractor"
            }
        ]
    }
}

Название `тип`	Описание
error.code `string`	Строковый код ошибки. Используйте для идентификации типа исключения
error.message `string`	Текстовое описание ошибки
error.validation `array`	Массив c деталями ошибки. Присутствует только в ошибках валидации данных `BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`
error.validation[].field `string`	Название поля, в котором возникла ошибка валидации
error.validation[].message `string`	Описание ошибки, связанной с указанным полем

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

Ошибки валидации объекта

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Поле	Описание ошибки	Как исправить
`documentId`	Не заполнено обязательное поле "documentId"	Передайте `documentId` в `fields`
`entityTypeId`	Не заполнено обязательное поле "entityTypeId"	Передайте `entityTypeId` в `fields`
`entityId`	Не заполнено обязательное поле "entityId"	Передайте `entityId` в `fields`
`id`	Поле "id" не доступно к заполнению	Уберите `id` из `fields`

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

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Несколько ошибок проверки полей могут прийти одним ответом в массиве validation.

Поле	Описание ошибки	Как исправить
`fields`	Обязательное поле `fields` не указано	Передайте объект `fields`
`documentId`	В поле `documentId` требуется тип данных `int` для такого запроса	Передайте целое число
`-`	Store document was not found	Документа с таким идентификатором нет или он недоступен пользователю. Проверьте идентификатор методом catalog.document.list
`-`	Type of store document is wrong	Поставщика можно привязать только к документу прихода с типом `A`
`-`	Unable to edit conducted document	Документ проведен. Отмените проведение методом catalog.document.cancel
`-`	Wrong entity type id	Передайте в `entityTypeId` значение `3` или `4`
`-`	Wrong entity id	Передайте в `entityId` положительное число
`-`	This contractor has been already bound to this document	Этот контакт или компания уже привязаны к документу
`-`	This document already has a Company contractor	К документу уже привязана компания. Удалите прежнюю привязку методом catalog.document.contractor.delete
`-`	Contractors should be provided by CRM	Поставщики документов берутся не из CRM. Методы работают, только если поставщиков документов складского учета ведет CRM
`-`	CRM module is required for document contractors	Методы работают только при установленном модуле CRM

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

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле	Описание ошибки	Как исправить
`-`	Неизвестное поле `#FIELD#` для сущности `DocumentContractorDto`	Передайте в `fields` только `documentId`, `entityTypeId`, `entityId`

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

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Поле	Описание ошибки	Как исправить
`-`	Доступ запрещен	Проверьте права пользователя на документы прихода, склады и каталог

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

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 catalog.document.contractor.add

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

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

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

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

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

Объект itemОбъект item

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

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

Ошибки валидации объектаОшибки валидации объекта

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

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

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

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

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

Была ли статья полезна?

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

Параметр fields

Примеры кода

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

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

Объект item

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

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

Ошибки валидации объекта

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

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

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

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

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