Add Vendor to Inventory Document catalog.documentcontractor.add
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
catalogWho 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 |
Description |
|
fields* |
Binding fields (detailed description) |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
documentId* |
Identifier of the inventory document of type "Incoming" |
|
entityTypeId* |
Type of CRM object: |
|
entityId* |
Identifier of the CRM object, contact, or company from the "Vendor" category. To obtain vendor identifiers:
|
Code Examples
How to Use Examples in Documentation
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 error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected 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>';
// client and ctx are already created — see the Go SDK section
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)
}
// The method wraps the response in an object with the "documentContractor" key.
raw, ok := b24.Unwrap(res.Result, "documentContractor")
if !ok {
return fmt.Errorf("no documentContractor key in the response")
}
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("parse response: %w", err)
}
fmt.Println(item.DocumentID, item.EntityID)
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 |
Description |
|
result |
Root element of the response |
|
documentContractor |
Object with data of the created vendor binding to the inventory document |
|
time |
Information about the request execution time |
Error Handling
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
HTTP code: 400
{
"error": "0",
"error_description": "Store document was not found"
}
Possible Error Codes
|
Code |
Description |
Value |
|
|
Store document was not found |
The specified document identifier does not exist or is inaccessible |
|
|
Type of store document is wrong |
The document is not of type "Incoming" |
|
|
Unable to edit conducted document |
The document has already been processed and cannot be changed |
|
|
Wrong entity type id |
An invalid |
|
|
Wrong entity id |
An invalid or non-existent |
|
|
This contractor has been already bound to this document |
Such a binding already exists |
|
|
This document already has a Company contractor |
A company is already bound to the document. Re-binding companies is prohibited |
|
|
Access denied |
Insufficient permissions to modify the document |
|
|
Contractors should be provided by CRM |
The CRM module is not active as a vendor for contractors |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Get a List of Vendor Bindings to Documents catalog.documentcontractor.list
- Remove Vendor Binding from Document catalog.documentcontractor.delete
- Get Description of Fields for Binding Vendor to Inventory Document catalog.documentcontractor.getFields
- How to Create a Vendor in CRM
- How to Retrieve a List of Vendors