catalog.documentcontractor.list
Получить список привязок поставщиков к документам
Описание
Метод catalog.documentcontractor.list возвращает список привязок поставщиков к документам складского учета. По умолчанию к запросу добавляются фильтры, ограничивающие выборку правами текущего пользователя.
Параметры
select
array
необязательный
Массив со списком полей catalog_documentcontractor, которые необходимо выбрать.
Если массив не передан или передан пустой массив, то будут выбраны все доступные поля документа
filter
object
необязательный
Объект для фильтрации выбранных привязок в формате {"field_1": "value_1", ..., "field_N": "value_N"}.
Возможные значения для field соответствуют полям объекта catalog_documentcontractor.
Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
- >= — больше либо равно
- > — больше
- <= — меньше либо равно
- < — меньше
- = — точное совпадение
- !=, ! — не равно
- @ — IN, в качестве значения передается массив
- !@ — NOT IN, в качестве значения передается массив
- % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
- =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищет значения, начинающиеся с «мол»
- "%мол" — ищет значения, заканчивающиеся на «мол»
- "%мол%" — ищет значения, где «мол» может быть в любой позиции
- !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обеих сторон
- !=% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищет значения, не начинающиеся с «мол»
- "%мол" — ищет значения, не заканчивающиеся на «мол»
- "%мол%" — ищет значения, где подстроки «мол» нет в любой позиции
- = — равно, точное совпадение, используется по умолчанию
- != — не равно
- ! — не равно
order
object
необязательный
Объект для сортировки выбранных документов в формате {"field_1": "order_1", ... "field_N": "order_N"}.
Возможные значения для field соответствуют полям объекта catalog_documentcontractor.
Возможные значения для order:
asc— в порядке возрастанияdesc— в порядке убывания
По умолчанию результаты упорядочены по возрастанию id
start
integer
необязательный
Параметр используется для управления постраничной навигацией.
Размер страницы — 50 записей.
Чтобы выбрать вторую страницу результатов, передайте значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.
Формула расчета значения параметра start:
start = (N-1) * 50, где N — номер нужной страницы.
Или передавайте значение из ключа next ответа
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","documentId"],"filter":{"documentId":7},"order":{"id":"ASC"},"start":0}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.documentcontractor.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","documentId"],"filter":{"documentId":7},"order":{"id":"ASC"},"start":0,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.documentcontractor.list
// 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 DocumentContractorResult = {
documentContractor: {
id: number
documentId: number
}[]
}
try {
// catalog.documentcontractor.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<DocumentContractorResult>({
method: 'catalog.documentcontractor.list',
params: {
select: ['id', 'documentId'],
filter: { documentId: 7 },
order: { id: 'ASC' },
start: 0,
},
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.length, 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 fetchDocumentContractorList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// catalog.documentcontractor.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'catalog.documentcontractor.list',
params: {
select: ['id', 'documentId'],
filter: { documentId: 7 },
order: { id: 'ASC' },
start: 0,
},
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.length, result.documentContractor)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchDocumentContractorList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.documentcontractor.list(
select=[
"id",
"documentId",
],
filter={
"documentId": 7,
},
order={
"id": "ASC",
},
start=0,
).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.list',
[
'select' => ["id", "documentId"],
'filter' => ['documentId' => 7],
'order' => ['id' => 'ASC'],
'start' => 0
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
'catalog.documentcontractor.list',
{
select: ["id", "documentId"],
filter: { "documentId": 7 },
order: { "id": "ASC" }
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
if (result.more())
{
result.next();
}
}
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.documentcontractor.list',
[
'select' => ["id", "documentId"],
'filter' => ['documentId' => 7],
'order' => ['id' => 'ASC'],
'start' => 0
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.documentcontractor.list", b24.Params{
"select": []string{"id", "documentId"},
"filter": b24.Params{
"documentId": 7,
},
"order": b24.Params{
"id": "ASC",
},
"start": 0,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("catalog.documentcontractor.list: %w", err)
}
// Метод заворачивает ответ в объект с ключом "documentContractor".
raw, ok := b24.Unwrap(res.Result, "documentContractor")
if !ok {
return fmt.Errorf("в ответе нет ключа documentContractor")
}
var items []struct {
DocumentID b24.ID `json:"documentId"`
ID b24.ID `json:"id"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.DocumentID)
}
Ответ
{
"result": {
"documentContractor": [
{
"documentId": 7,
"id": 5
}
]
},
"total": 1,
"time": {
"start": 1766146580,
"finish": 1766146580.866608,
"duration": 0.8666079044342041,
"processing": 0,
"date_start": "2025-12-19T15:16:20+03:00",
"date_finish": "2025-12-19T15:16:20+03:00",
"operating_reset_at": 1766147180,
"operating": 0
}
}
Возвращаемые данные
result
object
Корневой элемент ответа
documentContractor
catalog_documentContractor[]
Список привязок контрагентов, структура ответа зависит от параметра select
next
integer
Указатель смещения для следующей страницы. Передайте значение в параметр start, чтобы получить следующие 50 записей
total
integer
Общее количество документов
time
time
Информация о времени выполнения запроса
Обработка ошибок
{
"error": "0",
"error_description": "Access denied"
}
| Код | Описание | Значение |
|---|---|---|
0 |
Access denied | Недостаточно прав для просмотра документа или привязок |
0 |
Contractors should be provided by CRM | Модуль CRM не активен как поставщик контрагентов |

