Add Vendor to Inventory Document catalog.documentcontractor.add

Scope: catalog

Who can execute the method: user with permissions:
— "View" and "Create and edit" on document type "Incoming",
— "View Inventory" section
— "View Product Catalog"

The method catalog.documentcontractor.add creates a binding of a vendor, contact, or company to an inventory document.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	Binding fields (detailed description)

Parameter fields

Required parameters are marked with *

Name `type`	Description
documentId* `catalog_document.id`	Identifier of the inventory document of type "Incoming" `A`. Can be obtained using the method catalog.document.list
entityTypeId* `integer`	Type of CRM object: `3` — contact `4` — company
entityId* `integer`	Identifier of the CRM entity, contact, or company from the "Vendor" category. To obtain vendor identifiers: Get the category identifier with the code `CATALOG_CONTRACTOR_CONTACT` for contacts or `CATALOG_CONTRACTOR_COMPANY` for companies using the method crm.category.list. Use the obtained `categoryId` in the filter of the request crm.item.list

Code Examples

How to Use Examples in Documentation

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>';

Response Handling

HTTP code: 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+01:00",
                "date_finish": "2025-12-23T09:03:55+01:00",
                "operating_reset_at": 1766470435,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response
documentContractor `catalog_documentContractor`	Object with data of the created vendor binding to the inventory document
time `time`	Information about the request execution time

Error Handling

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

HTTP code: 400

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

Possible Error Codes

Code	Description	Value
`0`	Store document was not found	The specified document identifier does not exist or is inaccessible
`0`	Type of store document is wrong	The document is not of type "Incoming" `A`
`0`	Unable to edit conducted document	The document has already been processed and cannot be changed
`0`	Wrong entity type id	An invalid `entityTypeId` was provided, must be 3 or 4
`0`	Wrong entity id	An invalid or non-existent `entityId` was specified
`0`	This contractor has been already bound to this document	Such a binding already exists
`0`	This document already has a Company contractor	A company is already bound to the document. Re-binding companies is prohibited
`0`	Access denied	Insufficient permissions to modify the document
`0`	Contractors should be provided by CRM	The CRM module is not active as a vendor for contractors

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Overview of Methods

Remove Binding from Document

Add Vendor to Inventory Document catalog.documentcontractor.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning